---
title: "Finds a registration by the Id."
method: GET
path: "/api/registrations/{id}/summary"
tags: ["Registrations"]
---

# Finds a registration by the Id.

`GET /api/registrations/{id}/summary`

## Path parameters

- `id` string, uuid, required

## Headers

- `apikey` string, required

## Response `200`

Registration summary object.

- CredasApiModelsRegistrationsRegistrationSummary
  - `referenceId` string
  - `dateCreated` string, date-time, required
  - `status` 0 | 1 | 2 | 3 | 4 | 6, required — Unknown = 0, Submitted = 1, Approved = 2, Rejected = 3, Exported = 4, Invited = 6
  - `livenessVerified` boolean, required
  - `livenessStatus` 0 | 1 | 2 | 3 | 4, required — NotSubmitted = 0, Verified = 1, Unverified = 2, Unknown = 3, RetakeRequested = 4
  - `rightToWorkDocumentsProvided` 0 | 1 | 2, required — This property is no longer supported. Right to work is now available as an individual check.<br /> values=> Pending = 0, Pass = 1, Fail = 2
  - `dataChecksPerformed` boolean, required
  - `dataCheckResult` 0 | 1 | 2 | 3, required — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
  - `dataCheckSources` CredasApiModelsRegistrationsDataCheckSourceSummary[]
    - `sourceType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 — Unknown = 0, EditedElectoralRollUk = 1, LandlineAppendUk = 2, MortalityUk = 3, CreaditHeaderAmlUk = 4, NcoaAlertFlagUk = 5, NcoaAlertFullUk = 6, SanctionsEnhancedInternational = 7, PepEnhancedInternational = 8, NationalIdentityRegisterUk = 9, LandRegistry = 10
    - `label` string
    - `dateCreated` string, date-time
    - `status` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
    - `remarks` CredasApiModelsDataCheckCheckRemark[]
      - `category` 1 | 2 | 3 | 4 — Match = 1, Mismatch = 2, Warning = 3, Comment = 4
      - `description` string
    - `hasPepSanctionsData` boolean
    - `pepSanctionsData` CredasApiModelsDataCheckPepSanctionsPepSanctionItem[]
      - `id` string
      - `fullName` string
      - `aliases` string[]
      - `sanctionBodies` string[]
      - `sanctionDates` CredasApiModelsDataCheckPepSanctionsSanctionDate[]
        - `year` integer
        - `month` integer
        - `day` integer
        - `date` string, date-time
        - `type` 0 | 1 | 2 — Unknown = 0, Birth = 1, Death = 2
      - `addresses` CredasApiModelsDataCheckPepSanctionsSanctionAddress[]
        - `lines` string[]
      - `positions` CredasApiModelsDataCheckPepSanctionsSanctionPosition[]
        - `position` string
        - `country` string
    - `hasBeenOverridden` boolean
    - `person` CredasApiModelsDataCheckPerson
      - `forename` string, required
      - `middleName` string
      - `surname` string, required
      - `dateOfBirth` string, date-time, required
    - `address` CredasApiModelsDataCheckAddress
      - `addressLine1` string, required
      - `addressLine2` string
      - `addressLine3` string
      - `city` string, required
      - `postcode` string, required
      - `county` string
      - `country` string, required
  - `idVerification` CredasApiModelsRegistrationsIdVerification
    - `checkStatus` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
    - `hasBeenOverridden` boolean
  - `idDocuments` CredasApiModelsRegistrationsIdDocumentSummary[]
    - `id` string, uuid, required
    - `dateCreated` string, date-time, required
    - `description` string, required
    - `status` 0 | 1 | 2 | 3, required — Indicates the verification status of the document itself by combining visual analysis and NFC verification results. </br>Note that this may be a pass even if facial or name matches have failed.<br /> values=> Unknown = 0, Pass = 1, Refer = 2, Fail = 3
    - `facialMatch` boolean, required
    - `nameCheck` boolean, required
    - `nameCheckMethod` 0 | 1 | 2, required — Unknown = 0, Automatic = 1, Manual = 2
    - `nfcCheck` boolean, required
    - `nfcReadStatus` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10, required — Unknown = 0, Passed = 1, Failed = 2, NotAttempted = 3, Skipped = 4, Unavailable = 5, NotAllowed = 6, NotTrusted = 7, NotApplicable = 8, Expired = 9, UnavailableWebJourney = 10
    - `forename` string
    - `middleName` string
    - `surname` string
    - `fullName` string
    - `dateOfBirth` string, date-time
    - `countryCode` string
    - `country` string
    - `documentNumber` string
    - `expiryDate` string, date-time
    - `addressFull` string
    - `addressPostcode` string
    - `addressCity` string
    - `isUnderReview` boolean
    - `documentAnalysisResult` 0 | 1 | 2 | 3 | 4 | 5 | 10 | 11 — Unknown = 0, Passed = 1, Refer = 2, Expired = 3, NotSupported = 4, Undefined = 5, Fail = 10, NotPerformed = 11
    - `mrz1` string
    - `mrz2` string
    - `mrz3` string
    - `manuallyVerified` boolean
    - `documentSide` 0 | 1 | 2 — Front = 1, Back = 2
    - `primaryScanId` string, uuid
  - `email` string
  - `phoneNumber` string
  - `forename` string, required
  - `middleName` string
  - `surname` string, required
  - `regTypeId` string, uuid, required
  - `personalDetails` CredasApiModelsRegistrationsPersonalDetails
    - `forename` string
    - `surname` string
    - `dateOfBirth` string, date-time
    - `address` CredasApiModelsDataCheckAddress
      - `addressLine1` string, required
      - `addressLine2` string
      - `addressLine3` string
      - `city` string, required
      - `postcode` string, required
      - `county` string
      - `country` string, required
  - `bankAccountChecks` CredasApiModelsBankAccountsAccountVerificationResponse[]
    - `checkId` string, uuid
    - `checkDate` string, date-time
    - `sortcode` string
    - `accountNumber` string
    - `referenceId` string
    - `error` boolean
    - `accountValid` boolean
    - `sortcodeValidation` 0 | 1 | 2 | 3 | 4 — Unknown = 0, NoMatch = 1, Valid = 2, Invalid = 3, FiveDigitsMatched = 4
    - `sortcodeValidationText` string
    - `accountNumberValidation` 0 | 1 | 2 | 3 | 4 | 5 — Unknown = 0, NoMatch = 1, Valid = 2, Invalid = 3, SevenDigitsMatched = 4, SixDigitsMatched = 5
    - `accountNumberValidationText` string
    - `nameValidation` 0 | 1 | 2 — Unknown = 0, NoMatch = 1, Valid = 2
    - `nameValidationText` string
    - `addressValidation` 0 | 1 | 2 | 3 | 4 — Unknown = 0, NoMatch = 1, CurrentAddress = 2, PreviousAddress = 3, ForwardingAddress = 4
    - `addressValidationText` string
    - `accountStatus` 0 | 1 | 2 | 3 — Unknown = 0, NoMatch = 1, Live = 2, ClosedOrSettled = 3
    - `accountStatusText` string
    - `checkStatus` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
    - `hasBeenOverridden` boolean
    - `Forename` string
    - `MiddleName` string
    - `Surname` string
    - `Address1` string
    - `City` string
    - `PostCode` string
  - `creditStatusCheck` CredasApiModelsStatusChecksStatusCheck
    - `status` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
    - `hasBeenOverridden` boolean
    - `checkDate` string, date-time
    - `insolvency` CredasApiModelsStatusChecksInsolvencyInsolvencyResult[]
      - `type` 0 | 1 | 2 | 3 | 4 | 5 — Unknown = 0, NorthernIrelandBankruptcy = 1, ScottishSequestrationBankruptcy = 2, EnglandAndWalesIVA = 3, EnglandAndWalesDRO = 4, EnglandAndWalesBankruptcy = 5
      - `typeText` string
      - `name` string
      - `caseNo` string
      - `address` CredasApiModelsStatusChecksInsolvencyAddress
        - `address1` string
        - `address2` string
        - `address3` string
        - `address4` string
        - `address5` string
        - `postcode` string
        - `dps` string
        - `isEmpty` boolean
      - `dob` string, date-time
      - `court` string
      - `startDate` string, date-time
      - `status` string
      - `occupation` string
      - `aliases` string
      - `description` string
      - `serviceOffice` string
      - `telephoneNumber` string
      - `caseType` string
      - `tradingNames` string
      - `debtTotal` string
      - `assetTotal` string
      - `previousAddress` CredasApiModelsStatusChecksInsolvencyAddress
        - `address1` string
        - `address2` string
        - `address3` string
        - `address4` string
        - `address5` string
        - `postcode` string
        - `dps` string
        - `isEmpty` boolean
      - `presentationDate` string, date-time
    - `ccj` CredasApiModelsStatusChecksCCJCcjResult[]
      - `name` string
      - `dob` string, date-time
      - `address1` string
      - `address2` string
      - `address3` string
      - `address4` string
      - `address5` string
      - `postcode` string
      - `judgementDate` string, date-time
      - `judgementType` 0 | 1 | 2 | 3 | 4 | 5 — Unknown = 0, Judgement = 1, Satisfaction = 2, Revocation = 3, SetAside = 4, AdministrationOrder = 5
      - `judgementTypeText` string
      - `amount` string
      - `caseNumber` string
      - `courtName` string
      - `dateEnd` string, date-time
    - `companyDirector` CredasApiModelsStatusChecksCompanyDirectorCompanyDirectorResult[]
      - `matchType` 0 | 1 | 2 | 3 — Unknown = 0, NameAndDateOfBirth = 1, NameAndAddress = 2, NameAndAddressAndDateOfBirth = 3
      - `matchTypeText` string
      - `dateAppointed` string, date-time
      - `companyRegNo` string
      - `companyName` string
      - `registeredOffice` string
      - `companyAppointments` CredasApiModelsStatusChecksCompanyDirectorCompanyAppointment[]
        - `title` string
        - `name` string
        - `address` string
        - `dob` string, date-time
        - `occupation` string
        - `nationality` string
        - `appointmentDate` string, date-time
        - `appointmentType` string
    - `person` CredasApiModelsDataCheckPerson
      - `forename` string, required
      - `middleName` string
      - `surname` string, required
      - `dateOfBirth` string, date-time, required
    - `address` CredasApiModelsDataCheckAddress
      - `addressLine1` string, required
      - `addressLine2` string
      - `addressLine3` string
      - `city` string, required
      - `postcode` string, required
      - `county` string
      - `country` string, required
  - `proofOfOwnershipCheck` CredasApiModelsPropertyRegisterPropertyRegisterCheckResponse
    - `matchResult` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 — Unknown = 0, FullNameMatch = 1, SurnameMatch = 2, NoNameMatch = 3, NoAddressMatch = 4, TitleNotRegistered = 5, Unavailable = 6, OutOfHours = 7
    - `matchResultText` string
    - `propertyOwnership` 0 | 1 | 2 — Unknown = 0, SoleOwnership = 1, JointOwnership = 2
    - `propertyOwnershipText` string
    - `titleNumber` string
    - `checkStatus` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
    - `hasBeenOverridden` boolean
  - `rightToWorkCheck` CredasApiModelsRegistrationsSettlementStatus
    - `checkStatus` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
    - `hasBeenOverridden` boolean
    - `hasShareCodePdf` boolean
    - `shareCodeNameCheckStatus` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
    - `shareCodeFacialMatchStatus` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
  - `rightToRentCheck` CredasApiModelsRegistrationsSettlementStatus
    - `checkStatus` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
    - `hasBeenOverridden` boolean
    - `hasShareCodePdf` boolean
    - `shareCodeNameCheckStatus` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
    - `shareCodeFacialMatchStatus` 0 | 1 | 2 | 3 — Unknown = 0, Pass = 1, Refer = 2, Fail = 3
  - `isAgentLed` boolean
  - `livenessMethod` 0 | 1 | 2 — NotApplicable = 0, UniqueActionProcess = 1, Passive = 2
  - `customTermsAccepted` boolean
  - `customTermsAcceptedDateTime` string, date-time
  - `customTermsAcceptedVersion` integer
  - `createdByAgencyUserId` string, uuid
  - `hasSelfie` boolean
  - `dateCompleted` string, date-time
  - `hasLivenessPerformed` boolean
  - `DITFStatus` 0 | 1 | 2 — No = 0, Yes = 1, Pending = 2
  - `DITFDate` string, date-time
  - `safeHarbourVerifiedStatus` 0 | 1 | 2 — No = 0, Yes = 1, UnderReview = 2
  - `safeHarbourVerifiedDate` string, date-time
  - `Comments` CredasApiModelsRegistrationsRegistrationComment[]
    - `id` string, uuid
    - `name` string
    - `dateCreated` string, date-time
    - `comment` string
    - `type` 0 | 1 — General = 0, CheckRelated = 1
    - `checkType` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 — IdDocuments = 1, StandardChecks = 2, InternationalSanctionsAndPep = 3, CreditStatusCheck = 4, BankAccountCheck = 5, ProofOfOwnership = 6, RightToWork = 7, RightToRent = 8
  - `IsExpired` boolean
  - `VerifiedInAppDate` string, date-time
  - `CreatedByAgencyUserEmail` string
  - `id` string, uuid, required
  - `regCode` string, required

## Other responses

- `400` — If the service was supplied invalid data.
- `401` — If credentials supplied were invalid.
- `403` — If requesting entity have no permission to access the resource.
- `404` — If registration matching the Id was not found.
- `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)