Create a compliance record for a person

post

https://api.premote.io/v1/compliance-records/user/{userId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

userId

number

required

Body Params

recordTypeId

number

required

Record type from the catalogue

documentTypeLabel

string

Free-text name for a record filed under the generic "other" type.

countries

array of strings

ISO2 codes the record applies to.

countries

referenceNumber

string

issuingCountry

string

issuingInstitution

string

permitClass

string

canton

string

validFrom

string

YYYY-MM-DD

validUntil

string

YYYY-MM-DD

validUntilPermanent

boolean

The record is deliberately open-ended (a settlement permit, say). Distinct from omitting validUntil, which means "not supplied".

origin

string

enum

Allowed:

evidenceForm

string

enum

Allowed:

lifecycleState

string

enum

Allowed:

fileId

number

The uploaded document evidencing this record.

issuedAgainstId

number

The travel document this record was issued against — an ETA against a passport, say. Send null to clear the link; omit the key to leave it as it stands.

Responses

201

The created record.

403

Not permitted to write this person.

404

Unknown record type, file or linked record.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!