A whole job in one call: a letting, a sale, a finance client or an export shipment.

Starts the transaction, chooses its checks from what you send, runs them and issues the certificate; afterwards it is an ordinary transaction (txnId). Checks: the sanctions screen on everyone; PEP and adverse media by default on a sale and in finance ("pep": false to leave it out, "pep": true to add it to a letting); company and owners for each company with a companyNumber (in finance, "kyb": true runs the KYB package instead); the property risk pack when a property.postcode is given ("propertyPack": false to leave it out; a postcode and no parties is the pack alone). issuerName names your customer firm as issuer on the certificate of this job, instead of yours. An export shipment (export): each party screened against the six US export lists and the UK, UN, EU and US OFAC sanctions lists (a party with a UK companyNumber with everyone recorded in its ownership, as one check; any other by name with its country), and exportShipment { destination, goods, licence: { kind: number|none|not_assessed, number }, inTransitUK }: the destination's UK and US measures are read at the run, free, and go on the certificate. A screening record, not a licensing decision. Short of credit: HTTP 402 with the txnId of the job, kept as a draft to run after a top-up.

post/v1/suites/{suite}/check

Request

  • Base URL: https://api.stratumapis.com
  • URL: https://api.stratumapis.com/v1/suites/{suite}/check
  • Auth: API key in header X-Stratum-Key

Path parameters

suite'letting' | 'sale' | 'finance' | 'export' required

letting, sale, finance or export.

Response

Ran: the run reply, plus suite, txnId and the checks chosen.

Changes

No recorded changes to this operation across all 1 revision of this API.