---
title: "Creates new registration."
method: POST
path: "/api/registrations"
tags: ["Registrations"]
---

# Creates new registration.

`POST /api/registrations`

## Headers

- `apikey` string, required

## Request body

- CredasApiModelsRegistrationsAddRegistrationRequest
  - `forename` string, required
  - `middleName` string
  - `surname` string, required
  - `regTypeId` string, uuid, required
  - `referenceId` string
  - `sendSms` boolean, required
  - `sendEmail` boolean
  - `phoneNumber` string
  - `diallingCode` string
  - `emailAddress` string
  - `duplicateAcknowledgement` boolean
  - `parameters` CredasApiModelsRegistrationsKeyValueItem[]
    - `key` string
    - `value` string
  - `settings` CredasApiModelsRegistrationsRegistrationSettings
    - `capturePersonalDetails` boolean
    - `skipEmailStep` boolean
    - `requiredChecks` integer[] — The value of required checks determines what checks are performed. <br/>Unknown = 0,Id Documents = 1, Standard Checks = 2, International Sanctions and Pep = 3, Credit Status Check = 4, Bank Account Check = 5, Proof of Ownership = 6, Right to Work = 7, Right to Rent = 8<br />
    - `nameMatchRoutine` 1 | 2 — Fuzzy = 1, Strict = 2
  - `returnUrls` CredasApiModelsRegistrationsReturnUrls
    - `returnUrl` string
  - `provideWebJourneyLink` boolean
  - `significantPersonId` string, uuid

## Response `200`

Details of newly added registration.

- CredasApiModelsRegistrationsAddRegistrationResponse
  - `webJourneyUrl` CredasApiModelsRegistrationsJourneyUrl
    - `url` string
    - `validUntil` string, date-time
  - `id` string, uuid, required
  - `regCode` string, required

## Other responses

- `400` — If the service was supplied invalid data.
- `401` — If credentials supplied were invalid.
- `402` — Error code meaning that the operation was aborted due to insufficient credits.
- `500` — If an unexpected exception occurred whilst processing the request.

---

[API](https://skmtc.dev/credas/apis/credas-api.md) · [All operations](https://skmtc.dev/credas/apis/credas-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/credas/credas-api/revisions/a8dd82736563/schema)