First Leeward

Simulation

Simulate company status

POSThttps://api.firstleeward.com/v0/simulation/companies/:companyId/status

Simulates a company KYB outcome. Returns 204. Observe the change via GET /companies/{companyId} and COMPANY_STATUS_UPDATED. On Universal KYB projects the company application must be submitted first; otherwise the request returns SIMULATION_INVALID_STATE. An incomplete application returns COMPANY_APPLICATION_INCOMPLETE.

Authorizations

Authorizationstring · headerrequired

API key as Bearer token, e.g. Bearer YOUR_API_KEY

Headers

Leeward-Versionenum<string>required

API version (YYYY-MM-DD). Available option: 2026-09-18

Path Parameters

companyIdstring<uuid>required

Body

application/json

Option 1 · Active
statusstringrequired
applicationDetailsobject

Verified KYB attributes to persist alongside the status change on Managed KYB projects. Registration and address countries restricted for card issuance are rejected. Universal KYB projects take company details from the submitted application.

Show child attributes
legalEntityNamestringrequired

The legal entity's full name as verified at KYB. Used as both fullName and businessName when issuing Business cards.

registrationNumberstringrequired

The legal entity's business registration number.

countrystringrequired

ISO 3166-1 alpha-2 code of the legal entity's country of registration.

registeredAddressobjectrequired

Company address with a city

Show child attributes
Option 1 · City
line1stringrequired
line2stringrequired
citystringrequired
statestring | null
postalCodestring | null
countrystringrequired

ISO 3166-1 alpha-2 country code

Option 2 · State
line1stringrequired
line2stringrequired
citystring | null
statestringrequired
postalCodestring | null
countrystringrequired

ISO 3166-1 alpha-2 country code

operationalAddressobjectrequired

Company address with a city

Show child attributes
Option 1 · City
line1stringrequired
line2stringrequired
citystringrequired
statestring | null
postalCodestring | null
countrystringrequired

ISO 3166-1 alpha-2 country code

Option 2 · State
line1stringrequired
line2stringrequired
citystring | null
statestringrequired
postalCodestring | null
countrystringrequired

ISO 3166-1 alpha-2 country code

Option 2 · Rejected
statusstringrequired
Option 3 · In review
statusstringrequired
Option 4 · Action required
statusstringrequired
Option 5 · Cancelled
statusstringrequired

Response

204Response for status 204
400Response for status 400
Option 1 · SimulationInvalidStateError
errorobjectrequired
Show child attributes
codestringrequired
messagestringrequired
detailobject | nullrequired
Option 2 · CompanyApplicationIncompleteError
errorobjectrequired
Show child attributes
codestringrequired
messagestringrequired
detailobject | nullrequired
Option 3 · CompanyCountryRestrictedError
errorobjectrequired
Show child attributes
codestringrequired
messagestringrequired
detailobject | nullrequired
404Company not found
errorobjectrequired
Show child attributes
codestringrequired
messagestringrequired
detailobject | nullrequired