Skip to main content
POST
File incoming certificate

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Path Parameters

id
string
required

Body

application/json
requestId
string
required
expectedRevision
required
subjectKind
enum<string>
required
Available options:
properties.property,
properties.block
subjectId
string
required
kind
string
required
issuedOn
string | null
required
expiresOn
string | null
required
reference
string · null · null
eicrOutcome
string · null · null
remedialsDueOn
string · null · null
epcRating
string · null · null
coAlarmChecked
boolean · null · null

Response

Success

id
string
required
documentId
string
required
name
string
required
contentType
string | null
required
sizeBytes
required
source
enum<string>
required
Available options:
upload,
email
batchId
string | null
required
emailFrom
string | null
required
emailSubject
string | null
required
status
enum<string>
required
Available options:
to_file,
filed,
dismissed
revision
required
receivedAt
string
required
textState
string
required
postcodeMatches
object[]
required
suggestion
object | null
required
readiness
enum<string>
required
Available options:
reading,
ready,
needs_look
filed
object | null
required
decidedAt
string | null
required
dismissReason
string | null
required