POST request/n3rgy/consent

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Address	Address	None.
EmailAddress	string	None.
IsAmr	boolean	None.
IsHistorical	boolean	None.
MoveInDate	date	None.
MPAN	Collection of string	None.
MPRN	Collection of string	None.
Name	string	None.
PaymentMethodId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "address": {
    "city": "sample string 1",
    "country": "sample string 2",
    "line1": "sample string 3",
    "line2": "sample string 4",
    "postcode": "sample string 5",
    "county": "sample string 6"
  },
  "emailAddress": "sample string 2",
  "paymentMethodId": "sample string 3",
  "moveInDate": "2026-01-29T02:51:57.109169+00:00",
  "mpan": [
    "sample string 1",
    "sample string 2"
  ],
  "mprn": [
    "sample string 1",
    "sample string 2"
  ],
  "isAmr": true,
  "isHistorical": true
}

application/xml, text/xml

Sample:

<ConsentValidateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.N3rgy">
  <Address>
    <City>sample string 1</City>
    <Country>sample string 2</Country>
    <County>sample string 6</County>
    <Line1>sample string 3</Line1>
    <Line2>sample string 4</Line2>
    <Postcode>sample string 5</Postcode>
  </Address>
  <EmailAddress>sample string 2</EmailAddress>
  <IsAmr>true</IsAmr>
  <IsHistorical>true</IsHistorical>
  <MPAN xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </MPAN>
  <MPRN xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </MPRN>
  <MoveInDate>2026-01-29T02:51:57.109169+00:00</MoveInDate>
  <Name>sample string 1</Name>
  <PaymentMethodId>sample string 3</PaymentMethodId>
</ConsentValidateRequest>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Name"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Address.City"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Address.Country"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Address.Line1"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Address.Line2"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Address.Postcode"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Address.County"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EmailAddress"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PaymentMethodId"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MoveInDate"

2026-01-29T02:51:57.1091690+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MPAN[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MPAN[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MPRN[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MPRN[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsAmr"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsHistorical"

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ConsentValidateResponse

Name	Type	Additional information
ConsentUserGuid	string	None.
CustomerUniqueId	integer	None.
Message	string	None.
Meters	Collection of ConsentMeterResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "customerUniqueId": 1,
  "consentUserGuid": "sample string 2",
  "meters": [
    {
      "mpxn": "sample string 1",
      "fuel": "sample string 2",
      "status": true,
      "message": "sample string 4",
      "isN3rgyAddressVerified": true,
      "isStripePaymentVerified": true,
      "isN3rgyTrustedConsentAdded": true
    },
    {
      "mpxn": "sample string 1",
      "fuel": "sample string 2",
      "status": true,
      "message": "sample string 4",
      "isN3rgyAddressVerified": true,
      "isStripePaymentVerified": true,
      "isN3rgyTrustedConsentAdded": true
    }
  ],
  "message": "sample string 3"
}

application/xml, text/xml

Sample:

<ConsentValidateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Models.N3rgy">
  <ConsentUserGuid>sample string 2</ConsentUserGuid>
  <CustomerUniqueId>1</CustomerUniqueId>
  <Message>sample string 3</Message>
  <Meters>
    <ConsentMeterResponse>
      <Fuel>sample string 2</Fuel>
      <IsN3rgyAddressVerified>true</IsN3rgyAddressVerified>
      <IsN3rgyTrustedConsentAdded>true</IsN3rgyTrustedConsentAdded>
      <IsStripePaymentVerified>true</IsStripePaymentVerified>
      <Message>sample string 4</Message>
      <Mpxn>sample string 1</Mpxn>
      <Status>true</Status>
    </ConsentMeterResponse>
    <ConsentMeterResponse>
      <Fuel>sample string 2</Fuel>
      <IsN3rgyAddressVerified>true</IsN3rgyAddressVerified>
      <IsN3rgyTrustedConsentAdded>true</IsN3rgyTrustedConsentAdded>
      <IsStripePaymentVerified>true</IsStripePaymentVerified>
      <Message>sample string 4</Message>
      <Mpxn>sample string 1</Mpxn>
      <Status>true</Status>
    </ConsentMeterResponse>
  </Meters>
</ConsentValidateResponse>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CustomerUniqueId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ConsentUserGuid"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[0].Mpxn"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[0].Fuel"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[0].Status"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[0].Message"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[0].IsN3rgyAddressVerified"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[0].IsStripePaymentVerified"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[0].IsN3rgyTrustedConsentAdded"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[1].Mpxn"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[1].Fuel"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[1].Status"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[1].Message"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[1].IsN3rgyAddressVerified"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[1].IsStripePaymentVerified"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Meters[1].IsN3rgyTrustedConsentAdded"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e--