Poll a US KYB report request

GET /v1/us-kyb/reports/{request_id}

Poll a US KYB report request

cURL

curl --request GET \
  --url https://api.reprompt.io/v1/us-kyb/reports/{request_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "request_id": "<string>",
  "created_at": "<string>",
  "completed_at": "<string>",
  "report": {},
  "pdf_url": "<string>",
  "status": "completed"
}

Authorizations

Authorization · string · header · required

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

Headers

apiKey · string | null

Path Parameters

request_id · string · required

Query Parameters

org_slug · string | null

Response

200

application/json

Successful Response

UsKybStatusCompleted

UsKybStatusError

UsKybStatusProcessing

request_id · string · required

created_at · string · required

completed_at · string · required

report · Report · object · required

Full KYB report JSON.

pdf_url · string · required

Direct S3 URL for the generated PDF report.

status · string · default: completed

Allowed value: "completed"