v4

latestSwagger 2.02026-08-033766226.9 KB
Registrations

Creates new registration.

post/api/registrations

Headers

apikeystring required

ApiKey supplied.

Request body

forenamestring required
middleNamestring
surnamestring required
regTypeIdstring uuid required
referenceIdstring
sendSmsboolean required
sendEmailboolean
phoneNumberstring
diallingCodestring
emailAddressstring
duplicateAcknowledgementboolean
provideWebJourneyLinkboolean
significantPersonIdstring uuid

Example request

{
  "forename": "Alan",
  "middleName": null,
  "surname": "Harper",
  "regTypeId": "12345678-1234-1234-1234-1234567890ab",
  "referenceId": "HID-12345-336-10",
  "sendSms": false,
  "sendEmail": true,
  "phoneNumber": "7123456789",
  "diallingCode": "+44",
  "emailAddress": "user@email.com",
  "duplicateAcknowledgement": false,
  "parameters": [
    {
      "key": "Param1",
      "value": "Value 1"
    },
    {
      "key": "Param2",
      "value": "123456"
    },
    {
      "key": "Param3",
      "value": "true"
    }
  ],
  "settings": {
    "legislation": 3,
    "checkProfile": 2,
    "capturePersonalDetails": true,
    "skipEmailStep": true,
    "requiredChecks": null,
    "nameMatchRoutine": null
  },
  "returnUrls": {
    "returnUrl": "https://www.example.com/registration-complete/123456"
  },
  "provideWebJourneyLink": true,
  "significantPersonId": null
}

Response

Details of newly added registration.

idstring uuid required
regCodestring required