Skip to main content
POST
/
simulation
/
companies
/
{companyId}
/
status
Simulate company status
curl --request POST \
  --url https://sandbox.api.reap.global/simulation/companies/{companyId}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Reap-Version: <reap-version>' \
  --data '
{
  "status": "<string>",
  "applicationDetails": {
    "legalEntityName": "<string>",
    "registrationNumber": "<string>",
    "country": "<string>",
    "registeredAddress": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "postalCode": "<string>"
    },
    "operationalAddress": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "country": "<string>",
      "state": "<string>",
      "postalCode": "<string>"
    }
  }
}
'
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "detail": {}
  }
}

Authorizations

Authorization
string
header
required

API key as Bearer token

Headers

Reap-Version
enum<string>
required

API version (YYYY-MM-DD)

Available options:
2025-02-14
Example:

"2025-02-14"

Path Parameters

companyId
string<uuid>
required

Body

Simulate a company status change. ACTIVE requires applicationDetails so the simulated company matches the shape of one verified through AiPrise.

status
string
required
Allowed value: "ACTIVE"
applicationDetails
object
required

Verified KYB attributes to persist alongside the status change.

Response

The resource is not in a valid state for the requested simulation

error
object
required