POST api/v1/registration/confirmation/{requestUid}

Confirms the user registration.

Request Information

URI Parameters

Name	Description	Type	Additional information
requestUid	The request UID.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Returns the user.

UserViewModel

Name	Description	Type	Additional information
Logon	The user logon.	string	None.
Forename	The user forename.	string	None.
Surname	The user surname.	string	None.
OtherNames	The user other names.	string	None.
IsConfirmed	True if the user registration is confirmed; otherwise, false.	boolean	None.
CandidateReference	If this user is a candidate, returns the reference number from eclipse, if there is one set	string	None.
SecretKey2FA	The user secret key for 2 factor authentication.	string	None.
Is2FASiteWide	Two factor authentication type. False shows that user enabled 2fa only on change password. True means the 2fa will be anabled both on logon and change password.	boolean	None.
Uid	The GUID.	globally unique identifier	None.
Links	The links.	Collection of Link	None.
DateUpdated	Last time the record was updated	date	None.
UpdatedBy	Who updated the record last	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Logon": "sample string 1",
  "Forename": "sample string 2",
  "Surname": "sample string 3",
  "OtherNames": "sample string 4",
  "IsConfirmed": true,
  "CandidateReference": "sample string 6",
  "SecretKey2FA": "sample string 7",
  "Is2FASiteWide": true,
  "Uid": "18dfa84d-4131-4671-81d9-435cd3b6bdec",
  "Links": [
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    },
    {
      "Href": "http://webapihelppage1.com",
      "Method": "sample string 2",
      "Rel": "sample string 3",
      "Title": "sample string 4",
      "Type": "sample string 5"
    }
  ],
  "DateUpdated": "2025-10-27T14:02:40.6746728+00:00",
  "UpdatedBy": "sample string 10"
}

application/xml, text/xml

Sample:

<UserViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <DateUpdated>2025-10-27T14:02:40.6746728+00:00</DateUpdated>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
    <d2p1:Link>
      <d2p1:Href>http://webapihelppage1.com/</d2p1:Href>
      <d2p1:Method>sample string 2</d2p1:Method>
      <d2p1:Rel>sample string 3</d2p1:Rel>
      <d2p1:Title>sample string 4</d2p1:Title>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:Link>
  </Links>
  <Uid>18dfa84d-4131-4671-81d9-435cd3b6bdec</Uid>
  <UpdatedBy>sample string 10</UpdatedBy>
  <CandidateReference>sample string 6</CandidateReference>
  <Forename>sample string 2</Forename>
  <Is2FASiteWide>true</Is2FASiteWide>
  <IsConfirmed>true</IsConfirmed>
  <Logon>sample string 1</Logon>
  <OtherNames>sample string 4</OtherNames>
  <SecretKey2FA>sample string 7</SecretKey2FA>
  <Surname>sample string 3</Surname>
</UserViewModel>