Sign in

v4

latestSwagger 2.02026-08-033766226.9 KB
Registrations

Creates new registration record, adds an ID document and optional selfie image in one go.

It's designed to provide a quick integration path for external systems which capture these details.

post/api/registrations/instant

Headers

apikeystring required

ApiKey supplied.

Request body

regTypeIdstring uuid required
documentstring required
documentType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 9 | 10 | 11 required

Other = 0, Passport = 1, DrivingLicence = 2, Visa = 3, CscsCard = 4, HomeOfficeLetter = 5, BirthCertificate = 6, NationalIdCard = 7, ResidencePermit = 9, UtilityBill = 11

selfiestring
forenamestring required
middleNamestring
surnamestring required
referenceIdstring
significantPersonIdstring uuid

Example request

{
  "regTypeId": "12345678-1234-1234-1234-1234567890ab",
  "document": "Base64EncodedJpegImage",
  "documentType": 1,
  "documentParameters": null,
  "selfie": "Base64EncodedJpegImage",
  "forename": "Alan",
  "middleName": null,
  "surname": "Harper",
  "referenceId": "MyRef123",
  "parameters": [
    {
      "key": "Param1",
      "value": "Value 1"
    },
    {
      "key": "Param2",
      "value": "123456"
    },
    {
      "key": "Param3",
      "value": "true"
    }
  ],
  "significantPersonId": null
}

Response

OK response with object containing the document information.

documentType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 41 | 42 | 43 | 44 | 45 | 46 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 required

Unknown = 0, Passport = 1, DrivingLicense = 2, IdentificationCard = 3, TaxLetter = 4, NIC_Letter = 5, TV_Licence = 6, UtilityBill = 7, HighRiskWorkLicence = 8, TravelPermit = 9, BankLetter = 10, BenefitLetter = 11, BankStatement = 12, NINO_Letter = 13, CouncilTax = 14, ResidentPermit = 15, PhotoCard = 16, RepaymentLetter = 17, Invoice = 18, Visa = 19, AgeIdentificationCard = 20, MedicareCard = 21, MilitaryIdentificationCard = 22, UtilityLetter = 23, CouncilDocument = 24, JobLicence = 25, MembershipIDCard = 26, MilitaryIDCard = 27, ProofOfAgeCard = 28, TravelPermitNew = 29, WeaponsLicence = 30, AccountStatement = 41, TenancyAgreement = 42, BankDocument = 43, BankLetterNew = 44, BankStatementNew = 45, BenefitLetterNew = 46, CouncilDocumentNew = 48, CouncilLetter = 49, CouncilTaxNew = 50, DWPDocument = 51, HMRCDocument = 52, InformationSheet = 53, InsuranceDocument = 54, InsuranceLetter = 55, InvoiceNew = 56, NICLetter = 57, NINOLetter = 58, OfficialDocument = 59, OfficialLetter = 60, RepaymentLetterNew = 61, TaxLetterNew = 62, TaxStatement = 63, TelBill = 64, TelLetter = 65, TelecommunicationDocument = 66, TVLicence = 67, UniversityLetter = 68, UtilityBillNew = 69, UtilityDocument = 70, UtilityLetterNew = 71, WaterBill = 72, WaterDocument = 73, HighRiskWorkLicenceNew = 74, PhotoCardNew = 75, MedicareCardNew = 76, Certificate = 77

documentStatus1 | 2 | 3 required

Active = 1, Deleted = 2, UnderReview = 3

facialMatchboolean required
idstring uuid required
regCodestring required