POST api/v1/portals/{portalUid}/agents/registration

Registers an agent for the Eclipse Web API.

Request Information

URI Parameters

Name	Description	Type	Additional information
portalUid	The portal UID.	globally unique identifier	Required

Body Parameters

The agent registration.

AgentRegistration

Name	Description	Type	Additional information
Email	Gets or sets the email.	string	Required String length: inclusive between 0 and 255
Password	The logon password.	string	Required String length: inclusive between 0 and 255
Forename	The client contact forename.	string	String length: inclusive between 0 and 100
Surname	The client contact surname.	string	String length: inclusive between 0 and 100
JobTitle	Gets or sets the job title.	string	String length: inclusive between 0 and 100
Telephone	The contact telephone	string	String length: inclusive between 0 and 100
Mobile	The contact mobile.	string	String length: inclusive between 0 and 100
AgencyKey	Gets or sets the agency key.	string	Required String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "Password": "sample string 2",
  "Forename": "sample string 3",
  "Surname": "sample string 4",
  "JobTitle": "sample string 5",
  "Telephone": "sample string 6",
  "Mobile": "sample string 7",
  "AgencyKey": "sample string 8"
}

application/xml, text/xml

Sample:

<AgentRegistration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
  <AgencyKey>sample string 8</AgencyKey>
  <Email>sample string 1</Email>
  <Forename>sample string 3</Forename>
  <JobTitle>sample string 5</JobTitle>
  <Mobile>sample string 7</Mobile>
  <Password>sample string 2</Password>
  <Surname>sample string 4</Surname>
  <Telephone>sample string 6</Telephone>
</AgentRegistration>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the user confirmation.

UserConfirmationViewModel

Name	Description	Type	Additional information
User	The user.	UserViewModel	None.
Email	The email.	string	None.
RequestGuid	The request GUID.	globally unique identifier	None.
CandidateReference	The candidate reference number, if the user is a candidate and one has been set	string	None.

Response Formats

application/json, text/json

Sample:

{
  "User": {
    "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": "b5d9e22e-bdd8-4bea-9792-b0575c4369c5",
    "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:00:51.5994833+00:00",
    "UpdatedBy": "sample string 10"
  },
  "Email": "sample string 1",
  "RequestGuid": "8435e2d9-5373-47e5-9512-3844b8d191c2",
  "CandidateReference": "sample string 3"
}

application/xml, text/xml

Sample:

<UserConfirmationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.ViewModels">
  <CandidateReference>sample string 3</CandidateReference>
  <Email>sample string 1</Email>
  <RequestGuid>8435e2d9-5373-47e5-9512-3844b8d191c2</RequestGuid>
  <User>
    <DateUpdated>2025-10-27T14:00:51.5994833+00:00</DateUpdated>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/Eclipse.WebApi.Common.Models">
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>http://webapihelppage1.com/</d3p1:Href>
        <d3p1:Method>sample string 2</d3p1:Method>
        <d3p1:Rel>sample string 3</d3p1:Rel>
        <d3p1:Title>sample string 4</d3p1:Title>
        <d3p1:Type>sample string 5</d3p1:Type>
      </d3p1:Link>
    </Links>
    <Uid>b5d9e22e-bdd8-4bea-9792-b0575c4369c5</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>
  </User>
</UserConfirmationViewModel>