Skip to main content
POST
/
v1
/
us-kyb
/
reports
Create a US KYB report request
curl --request POST \
  --url https://api.reprompt.io/v1/us-kyb/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "business_name": "<string>",
  "address": {
    "address_line1": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postal_code": "<string>",
    "country_code": "<string>"
  }
}
'
{
  "request_id": "<string>",
  "poll_url": "<string>",
  "status": "processing",
  "stream": {
    "stream_id": "<string>",
    "channel": "<string>",
    "event_name": "kyb:stream:event"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

apiKey
string | null

Query Parameters

org_slug
string | null

Body

application/json
business_name
string
required
Minimum string length: 1
address
UsKybAddressRequest · object
required
submitted_by_name
string | null
tin
UsKybTinRequest · object
stream
boolean
default:false

Response

Successful Response

request_id
string
required
poll_url
string
required
status
string
default:processing
Allowed value: "processing"
stream
UsKybStreamMetadata · object