API docs by Redocly

External APIs (1.0)

Download OpenAPI specification:

Welcome to the Essent and Energiedirect API Gateway!

This portal provides detailed documentation for developers looking to integrate with Essent and Energiedirect services through our APIs.

Accessing the APIs

You can access the APIs for Essent and Energiedirect at the following locations:

These APIs are designed to provide developers with access to various functionalities and data related to Essent and Energiedirect services.

Authentication

The APIs require authentication, unless otherwise specified we use OpenID Connect for authentication. You'll need appropriate credentials and authorization to make requests to our APIs.

The OIDC discovery endpoints can be found at:

Request Quotas

Each consumer has a preconfigured request quota. When this quota is breached, you'll receive a 429 error code (too many requests).

Getting Started

To begin using our APIs, please follow these steps:

  1. Sign Up for Access: Contact your Essent or Energiedirect Partner Representative to fill out the API access form.

  2. Authentication: Use OpenID Connect to authenticate your requests. Your representative will provide you with credentials.

  3. Explore the Documentation: Browse through our API documentation to understand endpoints, parameters, and data formats.

  4. Start Integration: Begin integrating Essent and Energiedirect APIs into your applications or services.

  5. Go-Live: When everything is confirmed to be working on the acceptance environment, you'll receive production credentials.

Documentation

Our documentation provides details about the available endpoints, request and response formats, authentication procedures, and usage guidelines.

Support and Feedback

If you have any questions, concerns, or feedback regarding our APIs or the documentation, please reach out toyour account representative. We value your input and are here to assist you in integrating with our services.

Happy coding!

Become a Customer (BAC)

Add metadata to the flow

Request Body schema: application/json
required
required
object (NewCustomerMetaDataPayload)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    • "metadata": [
      • {
        • "name": "partner_id",
        • "value": "1010111101/true/1030"
        }
      ]
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Cancel an Add Product Case in BPM

Request Body schema: application/json
required
required
object (FlowIdRequest)
required
object (NewCustomerReasonPayload)

Responses

Request samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    },
  • "payload": {
    • "reason": "Technische fout"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Complete the new customer flow.

header Parameters
external-partner-id
string
Example: 12345678

The ID of the external partner

Request Body schema: application/json
required
object (NewCustomerPutConfirmationPayload)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    • "send_quotation": false,
    • "consents": {
      • "loyalty_consent": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "airmiles_consent": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "upload_to_social_media": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "action_mail": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "information_mail": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "news_letter": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "product_mail": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "account_data_mail": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "account_data_phone": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "automatic_profiling": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "consumption_advice_reminder": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "energy_advice_phone": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        },
      • "sustainability_advice_phone": {
        • "consent_status": "given",
        • "valid_from": "2024-01-01"
        }
      },
    • "contact_log": {
      • "note": "contact log details",
      • "channel": "telephone",
      • "external_partner_reference": "Improvers - Essent B2C - KID"
      },
    • "skip_communication": false,
    • "promoter": "I-10040999 | MoneyCalls"
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Creates an order for a customer

Request Body schema: application/json
required
required
object (NewCustomerCampaign)
required
object (NewCustomerExternalParty)
required
object (NewCustomerProcessData)
customer_segment
required
string
Enum: "household" "small_office_home_office" "small_medium_enterprise" "special" "rentals"

Customer segment

required
object (NewCustomerCustomerInformation)
required
object (NewCustomerCorrespondence)
required
Array of objects (NewCustomerOrderPayloadConnection)

The connections of the contract

required
object (NewCustomerPaymentInformation)
object (NewCustomerConsents)

Responses

Request samples

Content type
application/json
{
  • "campaign": {
    • "campaign_id": "123456",
    • "physical_incentive": {
      • "id": "123456"
      }
    },
  • "external_party": {
    • "external_partner_id": "123456",
    • "promotor": "123456",
    • "reference": "123456"
    },
  • "process_data": {
    • "is_switch": true,
    • "cooldown_applicable": true,
    • "enable_digital_invoice": true
    },
  • "customer_segment": "household",
  • "customer_information": {
    • "person": {
      • "prefix": "K",
      • "initials": "J",
      • "first_name": "John",
      • "last_name": "Doe",
      • "gender": "male",
      • "title": "heer",
      • "date_of_birth": "1984-07-12"
      },
    • "organization": {
      • "chamber_of_commerce_number": "17115973",
      • "organization_name": "Essent",
      • "legal_entity": "private_company",
      • "vat_number": "NL808083247B01",
      • "customer_sub_segment": "housing_association"
      }
    },
  • "correspondence": {
    • "department": "IT",
    • "start_date": "2024-01-01",
    • "phone": "+31235256677",
    • "email": "user@example.com",
    • "preferred_communication_channel": "email",
    • "pobox": "183",
    • "house_number": "10",
    • "postcode": "1577FH",
    • "house_number_extension": "A",
    • "street": "Koningsweg",
    • "city": "Den-Bosch",
    • "country": "NL"
    },
  • "connection": [ ],
  • "payment_information": {
    • "iban": "NL63ABNA0615407293",
    • "incoming_payment_method": "manual",
    • "payment_term": 28,
    • "invoice_address": {
      • "care_of_full_name": "L.C.A. ERCAN",
      • "pobox": "183",
      • "house_number": "10",
      • "postcode": "1577FH",
      • "house_number_extension": "A",
      • "street": "Koningsweg",
      • "city": "Den-Bosch",
      • "country": "NL"
      },
    • "reference": "No example available"
    },
  • "consents": {
    • "loyalty_consent": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "airmiles_consent": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "upload_to_social_media": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "action_mail": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "information_mail": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "news_letter": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "product_mail": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "account_data_mail": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "account_data_phone": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "automatic_profiling": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "consumption_advice_reminder": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "energy_advice_phone": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      },
    • "sustainability_advice_phone": {
      • "consent_status": "given",
      • "valid_from": "2024-01-01"
      }
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Creates or updates personal details of a new customer

Request Body schema: application/json
required
required
object (PersonalDetailsPayload)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    • "initials": "B.A.",
    • "first_name": "Bob",
    • "last_name": "Aalst",
    • "prefix": "van",
    • "gender": "female",
    • "date_of_birth": "1970-01-01"
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Get summary details of a flow

query Parameters
message
string
Example: message=The consents for actionMail and informationMail are deprecated

Returns a deprecation message when actionMail or informationMail is received

Responses

Response samples

Content type
application/json
{
  • "payload": {
    • "supply_address": {
      • "house_number": "1",
      • "postcode": "1081LB",
      • "street": "Street",
      • "house_number_extension": "a",
      • "city": "Gouda"
      },
    • "segment_details": {
      • "customer_segment": "household",
      • "customer_sub_segment": "housing_association"
      },
    • "correspondence_address": {
      • "addressType": "pobox_address",
      • "poBox": "90222",
      • "postalCode": "1234AA",
      • "city": "Boskoop",
      • "country": "NL"
      },
    • "payment_details": {
      • "iban": "NL20INGB0001234567",
      • "incoming_payment_method": "manual"
      },
    • "communication_details": {
      • "preferred_channel": "email",
      • "email": "example@essent.nl"
      },
    • "products": [
      • {
        • "id": "E_H_BD",
        • "description": "Elektriciteit Keuzetarief Groene Stroom",
        • "duration_in_years": "1",
        • "energy_type": "electricity"
        }
      ],
    • "start_date_details": [
      • {
        • "energy_type": "electricity",
        • "start_date": "2021-01-01",
        • "is_cooldown_applicable": true
        }
      ]
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Get the possible and/or selected start date of the contract

query Parameters
message
string
Example: message=The consents for actionMail and informationMail are deprecated

Returns a deprecation message when actionMail or informationMail is received

Responses

Response samples

Content type
application/json
{
  • "payload": [
    • {
      • "energy_type": "electricity",
      • "possible_start_dates": [
        • {
          }
        ],
      • "selected_start_date": "2021-01-01",
      • "limits": [
        • {
          }
        ]
      }
    ],
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

getOfferwithbudgetbillamountV1

Get a collection of a v1.

query Parameters
incentive_id
string

incentive identifier.

campaign_id
required
string
duration_in_years
required
string
Enum: "1" "2" "3" "5" "98" "flex"

Responses

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "655c7f89-48cf-48c8-9ab4-ec64fc96f332"
    },
  • "payload": [
    • {
      • "campaign": {
        • "id": "68600",
        • "name": "Retail Portal: Flex products E-Voucher",
        • "description": "Retail Portal: Flex products E-Voucher"
        },
      • "offer_overviews": [
        • {
          }
        ],
      • "vat_included": true,
      • "total_amounts": {
        • "expected_yearly_amount": 2511.8,
        • "expected_monthly_amount": 209.32
        },
      • "incentive": {
        • "id": "33101",
        • "description": "E-voucher",
        • "discount_price": 75,
        • "distribution_plan": "Direct, door derden"
        },
      • "disclaimer_code": "ZAOMDIS_SPEC_NL",
      • "disclaimer_url": "https://www.essent.nl/content/system/HTML/disclaimers/ZAOMDIS_SPEC_NL.html",
      • "budget_bill": {
        • "amount": 1200.8,
        • "limits": {
          }
        }
      }
    ]
}

putPropositionV2

Request Body schema: application/json
required
required
object (NewCustomerPutPropositionPayload)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    • "campaign_id": "60538",
    • "incentive_id": "40321",
    • "duration_in_years": "5"
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

putPropositionV3

Update an v3 based on information provided.

Request Body schema: application/json
optional
object

v3 to be updated.

Responses

Request samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "77bde5f0-98fd-4a0d-894d-06a4a0b93eda"
    },
  • "payload": {
    • "campaign_id": "60538",
    • "incentive_id": "40321",
    • "duration_in_years": "1"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "77bde5f0-98fd-4a0d-894d-06a4a0b93eda"
    }
}

Retrieve correspondence details of flow

Request Body schema: application/json
required
required
object (NewCustomerCorrespondenceDetailsPayload)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    • "email": "example@essent.nl",
    • "use_supply_address": true,
    • "phone": "+31617171717",
    • "preferred_channel": "email",
    • "correspondence_address": {
      • "addressType": "pobox_address",
      • "poBox": "90222",
      • "postalCode": "1234AA",
      • "city": "Boskoop",
      • "country": "NL"
      }
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Retrieves the offer with budget bill amount details for the customer

query Parameters
incentive_id
string
Example: incentive_id=151063

The id of the incentive

campaign_id
required
string
Example: campaign_id=4201

The id of the campaign

duration_in_years
required
string
Enum: "1" "2" "3" "5" "flex"
Example: duration_in_years=5

The duration in years of the offer

Responses

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    },
  • "payload": [
    • {
      • "budget_bill": {
        • "amount": 1000,
        • "limits": {
          }
        },
      • "disclaimer_code": "ZAOMDIS_SPEC_NL",
      • "disclaimer_url": "https://www.essent.nl/content/system/HTML/disclaimers/ZAOMDIS_SPEC_NL.html",
      • "campaign": {
        • "id": "105601",
        • "name": "erw: Verleng ZHG DF 1,3,5jr + inc",
        • "description": "Retail Portal: Flex products E-Voucher"
        },
      • "offer_overviews": [
        • {
          }
        ],
      • "vat_included": true,
      • "total_amounts": {
        • "expected_yearly_amount": 268.49,
        • "expected_monthly_amount": 22.37
        },
      • "incentive": {
        • "id": "33101",
        • "description": "E-voucher",
        • "short_description": "E-voucher",
        • "discount_price": 75,
        • "distribution_plan": "Direct, door derden",
        • "code": "GEEN_INC_WEL_TVL"
        }
      }
    ]
}

Saves additional information like if address is residential and has contract with another supplier

Request Body schema: application/json
required
required
Array of objects (PutAdditionalInformationBodyPayload)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": [
    • {
      • "name": "residential",
      • "value": true
      }
    ],
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Saves additional information like if address is residential and has contract with another supplier

Request Body schema: application/json
required
required
object (PutAdditionalInformationV3BodyPayload)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    • "residential": true,
    • "contract_with_another_supplier": true,
    • "complex": true,
    • "contact_date": "2024-06-01"
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Saves organisation details of a flow.

Request Body schema: application/json
required
required
object (OrganisationDetails)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    • "chamber_of_commerce_number": "17115973",
    • "organisation_name": "Essent",
    • "legal_entity": "private_company",
    • "vat_number": "NL808083247B01"
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Saves the ean details to the cache

Request Body schema: application/json
required
required
Array of objects (PutEanDetailsPayload) non-empty
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": [
    • {
      • "connect_ean": [
        • "871685900006591896"
        ]
      }
    ],
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Service Retrieves installation details of a customer

query Parameters
message
string
Example: message=The consents for actionMail and informationMail are deprecated

Returns a deprecation message when actionMail or informationMail is received

Responses

Response samples

Content type
application/json
{
  • "installation_id": "8716879400",
  • "connect_ean": "871687940008536400",
  • "energy_type": "electricity",
  • "supply_address": {
    • "country": "Netherlands",
    • "city": "'S-HERTOGENBOSCH",
    • "house_number_extension": "A",
    • "postcode": "1234 BB",
    • "street": "Langeweg",
    • "house_number": "23"
    },
  • "administrative_status": "AAN",
  • "grid_operator": "8716921000006",
  • "net_area": "871718518003014347",
  • "captar_code": "8742030201119",
  • "standard_annual_usage_peak": 964,
  • "standard_annual_usage_off_peak": 1334,
  • "standard_annual_return_peak": 0,
  • "standard_annual_return_off_peak": 0,
  • "meter_id": "000000000109454594",
  • "meter_type": "CVN",
  • "metering_direction": "CMB",
  • "metering_method": "AND",
  • "supply_status": "ACT",
  • "physical_status": "IAL",
  • "profile": "E1C",
  • "residential": true,
  • "complex": false,
  • "billing_month": "03",
  • "readability": "SMN",
  • "profile_description": "LS Nachttarief",
  • "block_heating": true,
  • "connection_value": "E-ENE-3x25",
  • "grid_operator_name": "Stedin",
  • "device": {
    • "device_id": "000000000025418348",
    • "temperature_correction": "N"
    }
}

Set the payment details of the flow

Request Body schema: application/json
required
required
object (NewCustomerPaymentDetails)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    • "iban": "NL20INGB0001234567",
    • "incoming_payment_method": "manual",
    • "payment_term": 14,
    • "invoice_reference": "Test Reference",
    • "use_correspondence_address": false,
    • "invoice_address": {
      • "addressType": "pobox_address",
      • "poBox": "90222",
      • "postalCode": "1234AA",
      • "city": "Boskoop",
      • "country": "NL"
      }
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Set the start date of the contract

Request Body schema: application/json
required
required
Array of objects (NewCustomerStartDatePayload)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": [
    • {
      • "start_date": "2021-01-01",
      • "energy_type": "electricity"
      }
    ],
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

This API allows a service agent for a prospect of Essent (or other labels), to adjust the budget bill plan for the prospect So that the agent can inform him correctly when becoming a customer

Request Body schema: application/json
required
required
object (BudgetBillAmount)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    • "budget_bill_amount": 1200
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

This API allows a service agent for a prospect of Essent (or other labels), to see the budget bill plan for the prospect So that the agent can inform him correctly when becoming a customer

query Parameters
message
string
Example: message=The consents for actionMail and informationMail are deprecated

Returns a deprecation message when actionMail or informationMail is received

Responses

Response samples

Content type
application/json
{
  • "payload": {
    • "budget_bill_amount": 1200,
    • "limits": {
      • "min_amount": 0,
      • "max_amount": 9999
      }
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

This API is used to save the consumption Details of a possible essent/energiedirect customer

Request Body schema: application/json
required
required
Array of objects (ConsumptionDetails)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": [
    • {
      • "energy_type": "electricity",
      • "standard_annual_usages": [
        • {
          }
        ]
      }
    ],
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

This API is used to Save the Supply Address of the customer.

Request Body schema: application/json
required
house_number
string^[1-9]\d{0,5}$

House number of the customer

postcode
string^[1-9]\d{3} ?[A-Z]{2}$

Valid Dutch Postcode with or without space between the first 4 numbers and the last 2 letters

street
string

Street

house_number_extension
string

house number extension

city
string

City

customer_segment
string
Enum: "household" "small_office_home_office" "small_medium_enterprise" "special" "rentals"

The customer segment type

customer_sub_segment
string
Enum: "housing_association" "project_contractors" "owners_association" "commercial_rental" "housing_association_intermediate_supplier" "project_contractors_intermediate_delivery" "commercial_rental_intermediate_supplier" "sme_single_site" "sme_multi_site" "soho" "spec_multi_site" "purchasing_combination" "government"

The customer subsegment type

connect_ean
Array of strings

connection identifier (EAN) of the electricity or gas connection

flow_id
string

The cache key that is created or used for this stateful flow instance

Responses

Request samples

Content type
application/json
{
  • "house_number": "1",
  • "postcode": "1081LB",
  • "street": "Street",
  • "house_number_extension": "a",
  • "city": "Gouda",
  • "customer_segment": "household",
  • "customer_sub_segment": "housing_association",
  • "connect_ean": [
    • "871287140324595564"
    ],
  • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Update an v1 based on information provided.

Request Body schema: application/json
required
required
object (BreakOffReasonPayload)
required
object (FlowIdRequest)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    • "breakoffreason": "Voucher kon niet gegenereerd worden"
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    }
}

Change Contract

getOfferwithbudgetbillamountV1

This Service retrieves the Offer with budget bill amount details for the customer

query Parameters
incentive_id
string

incentive identifier.

campaign_id
required
string

Unique Identifier of the campaign.

duration_in_years
required
string
Enum: "1" "2" "3" "5" "98" "flex"

Duration in years

Responses

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "655c7f89-48cf-48c8-9ab4-ec64fc96f332"
    },
  • "payload": [
    • {
      • "campaign": {
        • "id": "105601",
        • "name": "verw: Verleng ZHG DF 1,3,5jr + inc",
        • "description": "Retail Portal: Flex products E-Voucher"
        },
      • "offer_overviews": [
        • {
          }
        ],
      • "vat_included": true,
      • "total_amounts": {
        • "expected_yearly_amount": 2511.8,
        • "expected_monthly_amount": 209.32
        },
      • "incentive": {
        • "id": "33101",
        • "description": "E-voucher",
        • "discount_price": 75,
        • "distribution_plan": "Direct, door derden"
        },
      • "disclaimer_code": "ZAOMDIS_SPEC_NL",
      • "disclaimer_url": "https://www.essent.nl/content/system/HTML/disclaimers/ZAOMDIS_SPEC_NL.html",
      • "budget_bill": {
        • "amount": 1200.8,
        • "limits": {
          }
        }
      }
    ]
}

Puts the confirmation of the change in the contract

header Parameters
external-partner-id
string
Example: 132406992

The external partner Id

Request Body schema: application/json
required
required
object (FlowIdRequest)
required
object (PutConfirmationPayload)

Responses

Request samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    },
  • "payload": {
    • "contactlog_id": "195471567",
    • "send_confirmation_letter": true,
    • "send_quotation": true,
    • "external_partner_reference": "reference - something",
    • "promoter": "20432"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    }
}

Puts the confirmation of the change in the contract

Request Body schema: application/json
required
required
object (FlowIdRequest)
required
object (PutPropositionPayload)

Responses

Request samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    },
  • "payload": {
    • "offer_id": "4032",
    • "incentive_id": "151063",
    • "campaign_id": "4201",
    • "duration_in_years": "5"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    }
}

Retrieves the offer with budget bill amount details for the customer

query Parameters
incentive_id
string
Example: incentive_id=151063

The id of the incentive

campaign_id
required
string
Example: campaign_id=4201

The id of the campaign

duration_in_years
required
string
Enum: "1" "2" "3" "5" "flex"
Example: duration_in_years=5

The duration in years of the offer

Responses

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    },
  • "payload": [
    • {
      • "budget_bill": {
        • "amount": 1000,
        • "limits": {
          }
        },
      • "disclaimer_code": "ZAOMDIS_SPEC_NL",
      • "disclaimer_url": "https://www.essent.nl/content/system/HTML/disclaimers/ZAOMDIS_SPEC_NL.html",
      • "campaign": {
        • "id": "105601",
        • "name": "erw: Verleng ZHG DF 1,3,5jr + inc",
        • "description": "Retail Portal: Flex products E-Voucher"
        },
      • "offer_overviews": [
        • {
          }
        ],
      • "vat_included": true,
      • "total_amounts": {
        • "expected_yearly_amount": 268.49,
        • "expected_monthly_amount": 22.37
        },
      • "incentive": {
        • "id": "33101",
        • "description": "E-voucher",
        • "short_description": "E-voucher",
        • "discount_price": 75,
        • "distribution_plan": "Direct, door derden",
        • "code": "GEEN_INC_WEL_TVL"
        }
      }
    ]
}

This API fetches the current consumption of the customer

query Parameters
message
string
Example: message=The consents for actionMail and informationMail are deprecated

Returns a deprecation message when actionMail or informationMail is received

Responses

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    },
  • "payload": [
    • {
      • "energy_type": "electricity",
      • "standard_annual_usages": [
        • {
          }
        ]
      }
    ]
}

This API saves the consumption details for a customer

Request Body schema: application/json
required
required
object (FlowIdResponse)
required
Array of objects (ConsumptionDetails)

Responses

Request samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    },
  • "payload": [
    • {
      • "energy_type": "electricity",
      • "standard_annual_usages": [
        • {
          }
        ]
      }
    ]
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    }
}

This API saves the correspondence details for a customer

Request Body schema: application/json
required
required
object (FlowIdResponse)
required
object (CorrespondenceDetails)

Responses

Request samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    },
  • "payload": {
    • "contactPerson": "Kees Janssen",
    • "phoneNumber": "0612345678",
    • "emailAddress": "piet@hein.nl",
    • "correspondenceAddress": {
      • "addressType": "pobox_address",
      • "poBox": "90222",
      • "postalCode": "1234AA",
      • "city": "Boskoop",
      • "country": "NL"
      }
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    }
}

This API saves the payment details for a customer

Request Body schema: application/json
required
required
object (FlowIdRequest)
required
object (PutPaymentDetailsPayload)

Responses

Request samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    },
  • "payload": {
    • "iban": "NL44INGB0056476758",
    • "incoming_payment_method": "manual"
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    }
}

This API saves the startDate for a customer

Request Body schema: application/json
required
required
object (FlowIdRequest)
required
object (PutStartDatePayload)

Responses

Request samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5",
    • "message": "The consents for actionMail and informationMail are deprecated"
    },
  • "payload": {
    • "start_date": "2023-01-01",
    • "skip_cooldown": true
    }
}

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    }
}

This API starts the changeContract flow for salespartners

query Parameters
postcode
required
string
Example: postcode=1234AB

Postcode of the customer

house_number
required
string
Example: house_number=183

House number

contact_date
string
Example: contact_date=2023-03-22

Customer contacted date

house_number_extension
string
Example: house_number_extension=A

Extension of the house number

iban
string
Example: iban=NL63ABNA0615407293

IBAN of the customer

chamber_of_commerce_number
string
Example: chamber_of_commerce_number=17115973

KVK number

date_of_birth
string
Example: date_of_birth=1941-11-22

Date of birth

Responses

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    }
}

Consent

Update the status of customer's telemarketing consents

query Parameters
account_id
required
string = 10 characters ^\d+$
Example: account_id=0172198189

The business partner id of the account to lookup the contract groups

Request Body schema: application/json
required
Array
consent_type
required
string (TelemarketingConsentType)
Enum: "telemarketing_energy" "telemarketing_home"
status
required
string (ConsentStatus)
Enum: "informed" "given" "revoked"

The status of the consent

Responses

Request samples

Content type
application/json
[
  • {
    • "consent_type": "telemarketing_energy",
    • "status": "given"
    }
]

Response samples

Content type
application/json
{
  • "success": true
}

Contracting

Returns a list of current addresses where installations are registered

query Parameters
house_number
string^[1-9]\d{0,9}$
Example: house_number=10

House number of the customer

postcode
string^[1-9]\d{3}\s?[A-Z]{2}$
Example: postcode=1577FH

Valid Dutch Postcode with or without space between the first 4 numbers and the last 2 letters

house_number_extension
string <= 25 characters
Example: house_number_extension=B

House number extension of the customer

connect_ean
string = 18 characters
Example: connect_ean=871687940008536400

EAN code of the consumer

Responses

Response samples

Content type
application/json
[
  • {
    • "house_number": "10",
    • "postcode": "1577FH",
    • "house_number_extension": "B",
    • "street": "Churchstreet",
    • "city": "Funkytown",
    • "country": "NL"
    }
]

This Service can be used to upload a document proof for a sale

Request Body schema: application/json
required
external_partner_id
required
string [ 3 .. 10 ] characters

The external partner ID, length between 3 and 10 characters.

required
object (SaleDetails)
required
object (ProofDetails)

Responses

Request samples

Content type
application/json
{
  • "external_partner_id": "80101111",
  • "sale_details": {
    • "order_id": "93c48710-4c6a-45db-8e8d-94c83bf24a1f",
    • "date": "2021-05-25",
    • "address": {
      • "street": "Willemsplein",
      • "city": "'S-HERTOGENBOSCH",
      • "country": "2"
      }
    },
  • "proof_details": {}
}

Response samples

Content type
application/json
{
  • "document_id": "B2C$NOTSET$443003071$2$NOTSET"
}

Emobility

Charge station lead endpoint for external partners

Request Body schema: application/json
required
external_partner_id
string non-empty

External partner ID, you will receive the value to include in this field

product_type
required
string
Enum: "charge-card" "charge-station"

Product type

object (SalesPartnerPaymentDetails)
object (SalesPartnerChargeCardDetails)
object (EmobilityChargeStationDetails)
object (SalesPartnerBusinessDetails)
required
object (SalesPartnerPersonalDetails)
required
object (SalesPartnerAddress)
object (SalesPartnerAddress)
object (SalesPartnerLeadData)
campaign_id
string [ 1 .. 36 ] characters

Campaign ID, you will receive the value to include in this field

lease_contract_number
string

Lease contract number

lease_contract_duration
integer

Lease contract duration

product_id
string non-empty

Product ID

Responses

Request samples

Content type
application/json
{
  • "external_partner_id": "4be41f9d-1e9e-4d30-bb20-8a91c06ab37d",
  • "product_type": "charge-card",
  • "payment_details": {
    • "iban": "NL91ABNA0417164300",
    • "account_holder": "J. Jansen."
    },
  • "charge_card_details": {
    • "card_type": "ChargeCard",
    • "card_number": "NL-ESS-D12345678-G"
    },
  • "chargeStationDetails": {
    • "type": "pro-line",
    • "color": "Wit",
    • "fixedCable": false,
    • "mountType": "Paalmontage",
    • "interestedInReimbursement": false
    },
  • "business_details": {
    • "organization_name": "Essent B.V.",
    • "chamber_of_commerce_number": "17115973",
    • "interested_in_reimbursement": true
    },
  • "personal_details": {
    • "gender": "other",
    • "initials": "W.B.",
    • "prefix": "van der",
    • "last_name": "Boom",
    • "phone_number": "06-12345789",
    • "email_address": "w.boom@example.com",
    • "date_of_birth": "1990-12-31"
    },
  • "installation_address": {
    • "postal_code": "5211 AK",
    • "house_number": "4",
    • "house_number_extension": "A",
    • "street": "Willemsplein",
    • "city": "'s-Hertogenbosch"
    },
  • "correspondence_address": {
    • "postal_code": "5211 AK",
    • "house_number": "4",
    • "house_number_extension": "A",
    • "street": "Willemsplein",
    • "city": "'s-Hertogenbosch"
    },
  • "request_context": {
    • "employee": "J. Jansen",
    • "channel": "EV",
    • "service_partner": "Essent",
    • "store": "Store 1",
    • "product_type": "EV",
    • "campaign": "Campaign",
    • "lead_segment": "Lease",
    • "invoice_group": "Essent"
    },
  • "campaign_id": "4be41f9d-1e9e-4d30-bb20-8a91c06ab37d",
  • "lease_contract_number": "1234567890",
  • "lease_contract_duration": 36,
  • "product_id": "1234567890"
}

Response samples

Content type
application/json
{
  • "id": "eed79884-9fc4-47e6-844d-66b21169ab25"
}

Check service availability

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Delivery report endpoint for Drake & Farrell

Request Body schema: application/json
required
Array
QUANTITY
required
number
EXPIRYDATE
required
string
ITEMNUMBER
required
string
TRACINGURL
required
string
ITEMQUANTITY
required
number
ORDERACCOUNT
required
string
CONTAINERTYPE
required
string
WORKORDERTYPE
required
string
SALESORDERNAME
required
string
SHIPMENTNUMBER
required
string
SHIPMENTSTATUS
required
string
Enum: "Shipped" "Open" "Waved" "In Process" "Loaded" "Received"
TRACKINGNUMBER
required
string
CONTAINERNUMBER
required
string
ITEMBATCHNUMBER
required
string
SALESORDERNUMBER
required
string
EXTERNALITEMNUMBER
required
string
MODIFIEDDATEANDTIME
required
string
CUSTOMERSORDERREFERENCE
required
string
CUSTOMERREQUISITIONNUMBER
required
string

Responses

Request samples

Content type
application/json
[
  • {
    • "QUANTITY": 0,
    • "EXPIRYDATE": "string",
    • "ITEMNUMBER": "string",
    • "TRACINGURL": "string",
    • "ITEMQUANTITY": 0,
    • "ORDERACCOUNT": "string",
    • "CONTAINERTYPE": "string",
    • "WORKORDERTYPE": "string",
    • "SALESORDERNAME": "string",
    • "SHIPMENTNUMBER": "string",
    • "SHIPMENTSTATUS": "Shipped",
    • "TRACKINGNUMBER": "string",
    • "CONTAINERNUMBER": "string",
    • "ITEMBATCHNUMBER": "string",
    • "SALESORDERNUMBER": "string",
    • "EXTERNALITEMNUMBER": "string",
    • "MODIFIEDDATEANDTIME": "string",
    • "CUSTOMERSORDERREFERENCE": "string",
    • "CUSTOMERREQUISITIONNUMBER": "string"
    }
]

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "input_validation",
  • "message": "An instance of ApiBodyRequest has failed the validation:\n - property resourceId has failed the following constraints: isUuid \n"
}

Post prospect information to eMobility, returns a verification code that can be included in the email sent to customers.

Request Body schema: application/json
required
productType
required
string
Enum: "charge-card" "charge-station"
required
object (PersonalDetailsBase)

Personal details of the sales partner

externalPartnerId
required
string
object (PaymentDetails)
object (ChargeCardDetails)

Charge card details of the sales partner

object (BusinessDetails)

Business details of the sales partner

object (PostalAddress)

Postal address

object (PostalAddress)

Postal address

object (LeadData)

Lead data for the sales partner

campaignId
string [ 1 .. 50 ] characters
leaseContractNumber
string [ 1 .. 50 ] characters
leaseContractDuration
integer

Responses

Request samples

Content type
application/json
{
  • "externalPartnerId": "4be41f9d-1e9e-4d30-bb20-8a91c06ab37d",
  • "productType": "charge-card",
  • "paymentDetails": {
    • "iban": "NL91ABNA0417164300",
    • "accountHolder": "E. Boom"
    },
  • "chargeCardDetails": {
    • "cardNumber": "NL-ESS-D12345678-G",
    • "cardType": "ChargeCard"
    },
  • "businessDetails": {
    • "organizationName": "Essent B.V.",
    • "chamberOfCommerceNumber": "17115973",
    • "interestedInReimbursement": false
    },
  • "personalDetails": {
    • "gender": "other",
    • "initials": "E.",
    • "prefix": "van der",
    • "lastName": "Boom",
    • "phoneNumber": "0612345789",
    • "emailAddress": "e.boom@gmail.com",
    • "dateOfBirth": "1990-12-31"
    },
  • "installationAddress": {
    • "postalCode": "5211 AK",
    • "houseNumber": "4",
    • "houseNumberAddition": "a",
    • "street": "Willemsplein",
    • "city": "'s-Hertogenbosch"
    },
  • "correspondenceAddress": {
    • "postalCode": "5211 AK",
    • "houseNumber": "4",
    • "houseNumberAddition": "a",
    • "street": "Willemsplein",
    • "city": "'s-Hertogenbosch"
    },
  • "requestContext": {
    • "employee": "J. Jansen",
    • "channel": "EV",
    • "servicePartner": "Essent",
    • "store": "Essent Zwolle",
    • "productType": "EV",
    • "campaign": "EV Voorjaar campagne 2024",
    • "leadSegment": "Lease"
    },
  • "campaignId": "4be41f9d-1e9e-4d30-bb20-8a91c06ab37d",
  • "leaseContractNumber": "1234567890",
  • "leaseContractDuration": 36
}

Response samples

Content type
application/json
{
  • "verificationCode": "01J2XEGJGPR0T37MD0XMEPBB9K"
}

Eplus

patchOpportunitiesV2

This API is used to receive the status update from the service partner.

path Parameters
id
required
string^[0-9]+$

id of the opportunity created

Request Body schema: application/json
optional
object
reason
string
external_id
string [ 1 .. 36 ] characters

quote_id from sustainables can be used as value

invoice_amount
number >= 0

amount in eur product is being invoiced at excl vat

lead_id
string^[0-9]{1,10}$

Identifier for a Lead

changed_on
required
string <date-time>
service_partner_name
required
string [ 1 .. 40 ] characters
remarks
string [ 1 .. 1000 ] characters
logged_by
required
string [ 1 .. 100 ] characters

System or Application or Agent who is sending the request

status
required
string

Responses

Request samples

Content type
application/json
{
  • "external_id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22",
  • "lead_id": "123456",
  • "status": "OpenLead",
  • "reason": "Contactgegevens niet correct",
  • "invoice_amount": 5000,
  • "contract_details": {
    • "contract_type": "Huur",
    • "maintenance_contract": true
    },
  • "service_partner_name": "Volta Solar",
  • "logged_by": "John Doe",
  • "remarks": "client requested extra installation information",
  • "changed_on": "2017-07-21T17:32:28Z"
}

Response samples

Content type
application/json
{
  • "error": {
    • "code": "1039",
    • "message": "MoveIn and MoveOut addresses are same"
    }
}

This API is used to receive the Lead from Sustainables and load lead information to suiteCRM.

Request Body schema: application/json
required
required
object (RequestContext)
external_id
string [ 1 .. 36 ] characters

quote_id from sustainables can be used as value

required
object (Lead)
required
object (OfferedProduct)
temperature
required
number [ 0 .. 4 ]

Temperature of sustainable

contract_type
string
Enum: "Huur" "Koop" "Koop en Huur"

Type of contract

service_request_uri
string <url>

This is a document which we can share with the service partners.

created_on
required
string\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d....

Current time of the opportunity update

remarks
string [ 0 .. 1000 ] characters

Any additional remarks

object (Timeslot)
iban
string

IBAN number of the account

account_holder
string

Name of the account holder

organization_name
string

Name of the business organization

chamber_of_commerce_number
string

Chamber of commerce number of the business

interested_in_reimbursement
boolean

If the reimbursement is needed or not

Responses

Request samples

Content type
application/json
{
  • "request_context": {
    • "logged_by": "John Doe",
    • "channel": "PlusJeHuis",
    • "sub_channel": "Inbound",
    • "service_partner_branch": "Amsterdam",
    • "request_type": "Advies",
    • "campaign_name": "Demo campaign"
    },
  • "external_id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22",
  • "lead": {
    • "title": "Heer",
    • "initials": "S.",
    • "first_name": "Ronald",
    • "prefix": "van",
    • "last_name": "Veenstra",
    • "date_of_birth": "1978-07-02",
    • "communication_address": {
      • "street": "Willemsplein",
      • "city": "'S-HERTOGENBOSCH",
      • "country": "2"
      },
    • "delivery_address": {
      • "street": "Willemsplein",
      • "city": "'S-HERTOGENBOSCH",
      • "country": "2"
      },
    • "billing_address": {
      • "street": "Willemsplein",
      • "city": "'S-HERTOGENBOSCH",
      • "country": "2"
      },
    • "phone": "+31235256677",
    • "email": "example@domain.com",
    • "allow_data_usage": true,
    • "allow_promotional_updates": true
    },
  • "offered_product": {
    • "category": "Zonneboiler",
    • "description": "Zonneboiler is being offered in combination with another product",
    • "sub_category": "Comfort_260",
    • "quantity": 12,
    • "details": [
      • {
        • "key": "ExpectedAnnualConsumption",
        • "value": "1000"
        }
      ]
    },
  • "temperature": 0,
  • "contract_type": "Huur",
  • "service_request_uri": "https://ts-rq-essent-test.azurewebsites.net/documenten/Adviesrapport?customerId=[CustomerID]&quoteId=[QuoteID]",
  • "created_on": "2017-07-21T17:32:28Z",
  • "remarks": "client requested extra installation information",
  • "timeslot": {
    • "date": "2024-07-01",
    • "time": "12:00:00",
    • "id": "99fb2eb0-c202-4e37-90f6-4880e645f9c4"
    },
  • "iban": "NL91ABNA0417164300",
  • "account_holder": "J. Jansen.",
  • "organization_name": "Essent B.V.",
  • "chamber_of_commerce_number": "17115973",
  • "interested_in_reimbursement": true
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "input_validation",
  • "message": "An instance of ApiBodyRequest has failed the validation:\n - property resourceId has failed the following constraints: isUuid \n"
}

This API is used to receive the Lead from third parties and load lead information to suiteCRM.

Request Body schema: application/json
required
required
object (LeadThirdParty)
required
object (RequestContextThirdParty)
option3
string

Option 3 - Adobe ID

option5
string

Option 5 - Click ID

external_id
string [ 1 .. 36 ] characters

quote_id from sustainables can be used as value

required
object (OfferedProduct)
temperature
required
number [ 0 .. 4 ]

Temperature of sustainable

contract_type
string
Enum: "Huur" "Koop" "Koop en Huur"

Type of contract

service_request_uri
string <url>

This is a document which we can share with the service partners.

created_on
required
string\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d....

Current time of the opportunity update

remarks
string [ 0 .. 1000 ] characters

Any additional remarks

object (Timeslot)
iban
string

IBAN number of the account

account_holder
string

Name of the account holder

organization_name
string

Name of the business organization

chamber_of_commerce_number
string

Chamber of commerce number of the business

interested_in_reimbursement
boolean

If the reimbursement is needed or not

Responses

Request samples

Content type
application/json
{
  • "lead": {
    • "company_name": "ACME Corporation",
    • "delivery_address": {
      • "street": "Willemsplein",
      • "city": "'S-HERTOGENBOSCH",
      • "country": "2"
      },
    • "energy_usage": "100",
    • "title": "Heer",
    • "initials": "S.",
    • "first_name": "Ronald",
    • "prefix": "van",
    • "last_name": "Veenstra",
    • "date_of_birth": "1978-07-02",
    • "communication_address": {
      • "street": "Willemsplein",
      • "city": "'S-HERTOGENBOSCH",
      • "country": "2"
      },
    • "billing_address": {
      • "street": "Willemsplein",
      • "city": "'S-HERTOGENBOSCH",
      • "country": "2"
      },
    • "phone": "+31235256677",
    • "email": "example@domain.com",
    • "allow_data_usage": true,
    • "allow_promotional_updates": true
    },
  • "request_context": {
    • "brand": "Essent",
    • "product_type": "Zon",
    • "reference_checkbox": true,
    • "reference_postcode": "1234 AB",
    • "reference_city": "Amsterdam",
    • "reference_street": "Straat",
    • "reference_house_number": "1",
    • "reference_house_number_extension": "A",
    • "campaign_id": "campaign1",
    • "website": "example.com",
    • "logged_by": "John Doe",
    • "channel": "PlusJeHuis",
    • "sub_channel": "Inbound",
    • "service_partner_branch": "Amsterdam",
    • "request_type": "Advies",
    • "campaign_name": "Demo campaign"
    },
  • "option3": "32e6c316-1a1c-416e-86ee-bacd5d6c59d3",
  • "option5": "62c55192-9a5b-42e2-a168-6b67990ae564",
  • "external_id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22",
  • "offered_product": {
    • "category": "Zonneboiler",
    • "description": "Zonneboiler is being offered in combination with another product",
    • "sub_category": "Comfort_260",
    • "quantity": 12,
    • "details": [
      • {
        • "key": "ExpectedAnnualConsumption",
        • "value": "1000"
        }
      ]
    },
  • "temperature": 0,
  • "contract_type": "Huur",
  • "service_request_uri": "https://ts-rq-essent-test.azurewebsites.net/documenten/Adviesrapport?customerId=[CustomerID]&quoteId=[QuoteID]",
  • "created_on": "2017-07-21T17:32:28Z",
  • "remarks": "client requested extra installation information",
  • "timeslot": {
    • "date": "2024-07-01",
    • "time": "12:00:00",
    • "id": "99fb2eb0-c202-4e37-90f6-4880e645f9c4"
    },
  • "iban": "NL91ABNA0417164300",
  • "account_holder": "J. Jansen.",
  • "organization_name": "Essent B.V.",
  • "chamber_of_commerce_number": "17115973",
  • "interested_in_reimbursement": true
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "input_validation",
  • "message": "An instance of ApiBodyRequest has failed the validation:\n - property resourceId has failed the following constraints: isUuid \n"
}

This service receives the status update from the service partner

path Parameters
opportunityId
required
string^[-+]?[0-9]+$
Example: 654321

Id of the opportunity created

Request Body schema: application/json
required
external_id
string [ 1 .. 36 ] characters

quote_id from sustainables can be used as value

lead_id
string[0-9]{1,10}

Identifier for a Lead

status
required
string

Status for the opportunity

reason
string

Reason for update

invoice_amount
number >= 0

Amount in eur product is being invoiced at excl vat

object (Contractdetails)
service_partner_name
required
string [ 1 .. 40 ] characters

Short name of a service partner e.g. Volta Solar, NL Isoleert, Isoprofs, Energiewacht, Energiewacht Groep, Geas, Kemkens, Volta Limburg, WoonVeilig

logged_by
required
string [ 1 .. 100 ] characters

System or Application or Agent who is sending the request

remarks
string [ 1 .. 1000 ] characters

Any additional remarks

changed_on
required
string\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d....

Current time of the opportunity update

Responses

Request samples

Content type
application/json
{
  • "external_id": "6a2f41a3-c54c-fce8-32d2-0324e1c32e22",
  • "lead_id": "123456",
  • "status": "OpenLead",
  • "reason": "Contactgegevens niet correct",
  • "invoice_amount": 5000,
  • "contract_details": {
    • "contract_type": "Huur",
    • "maintenance_contract": true
    },
  • "service_partner_name": "Volta Solar",
  • "logged_by": "John Doe",
  • "remarks": "client requested extra installation information",
  • "changed_on": "2017-07-21T17:32:28Z"
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "input_validation",
  • "message": "An instance of ApiBodyRequest has failed the validation:\n - property resourceId has failed the following constraints: isUuid \n"
}

This λ function is used to receive an opportunity and publish it to a SNS topic

Request Body schema: application/json
required
required
object
opportunityId
required
string

The opportunity ID

required
object
status
required
string
Enum: "OpenLead" "Offerte" "GeenOfferte" "GeenOrder" "Order" "Gereed" "Gefactureerd" "GeenInstallatie"

The status

servicePartnerName
required
string
Enum: "Energiewacht" "Energiewacht West" "EnergieWonen" "Kemkens" "NL Isoleert" "Volta Limburg" "Essent Emob"

The name of the service partner

required
object
required
string or string

The type of contract

temperature
required
number [ 0 .. 4 ]

The temperature of the lead

preferredContactOn
required
string

The preferred date of contact

createdOn
required
string

The date of creation

transferredOn
required
string

The date of transfer

remarks
required
string

Remarks

required
object
adobeId
required
string

Adobe ID

clickId
required
string

Click ID

referentieStreet
required
string

Reference Street

referentieHouseNumber
required
string

Reference House number

referentieHouseNumberExtension
required
string

Reference House number extension

referentiePostcode
required
string

Reference postcode

referentieCity
required
string

Reference city

Responses

Request samples

Content type
application/json
{
  • "requestContext": {
    • "loggedBy": "string",
    • "channel": "string",
    • "subChannel": "string",
    • "servicePartnerBranch": "string",
    • "requestType": "Directe Offerte Aanvraag",
    • "campaignName": "string",
    • "brand": "string"
    },
  • "opportunityId": "string",
  • "offeredProduct": {
    • "category": "string",
    • "subCategory": "string",
    • "description": "string",
    • "quantity": "string"
    },
  • "status": "OpenLead",
  • "servicePartnerName": "Energiewacht",
  • "lead": {
    • "leadId": "string",
    • "title": "string",
    • "initials": "string",
    • "firstName": "string",
    • "prefix": "string",
    • "lastName": "string",
    • "dateOfBirth": "2019-08-24",
    • "communicationAddress": {
      • "postcode": "string",
      • "street": "string",
      • "houseNumber": "string",
      • "houseNumberExtension": "string",
      • "city": "string"
      },
    • "deliveryAddress": {
      • "postcode": "string",
      • "street": "string",
      • "houseNumber": "string",
      • "houseNumberExtension": "string",
      • "city": "string"
      },
    • "billingAddress": {
      • "postcode": "string",
      • "street": "string",
      • "houseNumber": "string",
      • "houseNumberExtension": "string",
      • "city": "string"
      },
    • "phone": "string",
    • "email": "user@example.com",
    • "allowDataUsage": true,
    • "allowPromotionalUpdates": true,
    • "paymentInformation": {
      • "iban": "string",
      • "accountHolder": "string"
      },
    • "businessInformation": {
      • "organizationName": "string",
      • "chamberOfCommerceNumber": "string",
      • "interestedInReimbursement": true
      }
    },
  • "contractType": "Huur",
  • "temperature": 4,
  • "preferredContactOn": "string",
  • "createdOn": "string",
  • "transferredOn": "string",
  • "remarks": "string",
  • "details": {
    • "keyValue": [
      • {
        • "key": "string",
        • "value": "string"
        }
      ]
    },
  • "adobeId": "string",
  • "clickId": "string",
  • "referentieStreet": "string",
  • "referentieHouseNumber": "string",
  • "referentieHouseNumberExtension": "string",
  • "referentiePostcode": "string",
  • "referentieCity": "string"
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "input_validation",
  • "message": "An instance of ApiBodyRequest has failed the validation:\n - property resourceId has failed the following constraints: isUuid \n"
}

Ezspa

This API serves as a proxy API for EZSPA Application.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "BadRequest",
  • "message": "An instance of RegistrationTimestamp has failed the validation:\n"
}

This API serves as a proxy API for EZSPA Application.

header Parameters
client_id
required
string

The client identifier which is appended after authentication at the API Gateway.

partnerkey
required
string

The partnerkey which is directly provided by the sales partner.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "BadRequest",
  • "message": "An instance of RegistrationTimestamp has failed the validation:\n"
}

This API serves as a proxy API for EZSPA Application.

header Parameters
client_id
required
string

The client identifier which is appended after authentication at the API Gateway.

partnerkey
required
string

The partnerkey which is directly provided by the sales partner.

Request Body schema: application/json
ExternalIdentifier
string
RegistrationTimestamp
string
DataEntryTimestamp
string
TariffMonth
number
AgentCode
string
CampaignCode
string
HappyCallFeedbackOverride
number
Channel
number
IncentiveCode
string
CarCerConsent
boolean
object (EZSPAOrganization)

Responses

Request samples

Content type
application/json
{
  • "ExternalIdentifier": "db582feb-ee93-4d15-8972-35787772cb8",
  • "RegistrationTimestamp": "2024-03-20T11:19:15+01:00",
  • "DataEntryTimestamp": "2024-03-20T11:19:15+01:00",
  • "TariffMonth": 4,
  • "AgentCode": "ECN42",
  • "CampaignCode": "ISLAZ0001",
  • "HappyCallFeedbackOverride": "1",
  • "Channel": 2,
  • "IncentiveCode": "200euro",
  • "CarCerConsent": true,
  • "Organization": {
    • "Name": "Essent Test Request",
    • "Kvk": "09118704",
    • "Payment": {
      • "BankAccount": "NL65INGB0000000111",
      • "PaymentMethod": 2
      },
    • "Contact": {
      • "message": "Message"
      },
    • "Agreements": [
      • {
        • "IsResidential": true,
        • "ContractDuration": 36,
        • "SupplyAddress": {
          },
        • "Product": "VZ",
        • "Connections": [
          ]
        }
      ]
    }
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "BadRequest",
  • "message": "An instance of RegistrationTimestamp has failed the validation:\n"
}

This API serves as a proxy API for EZSPA Application.

header Parameters
client_id
required
string

The client identifier which is appended after authentication at the API Gateway.

partnerkey
required
string

The partnerkey which is directly provided by the sales partner.

Responses

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "BadRequest",
  • "message": "An instance of RegistrationTimestamp has failed the validation:\n"
}

Feh

Create a new third party lead

Request Body schema: application/json
required
type
required
string (CreateLeadThirdPartyType)
Value: "thirdParty"

The type of lead

required
object (LeadThirdPartyLeadSchema)

Lead information for third party lead

object

Consent information

required
object (LeadThirdPartyContextSchema)

Context information for third party lead

required
object
required
Array of objects (LeadProductSchema) = 1 items

Responses

Request samples

Content type
application/json
{
  • "type": "thirdParty",
  • "lead": {
    • "title": "Mr",
    • "initials": "J",
    • "firstName": "John",
    • "prefix": "van",
    • "lastName": "Doe",
    • "addresses": {
      • "communication": {
        • "postcode": "1234 AB",
        • "street": "Straat",
        • "houseNumber": "1",
        • "houseNumberExtension": "a",
        • "city": "Amsterdam"
        },
      • "delivery": {
        • "postcode": "1234 AB",
        • "street": "Straat",
        • "houseNumber": "1",
        • "houseNumberExtension": "a",
        • "city": "Amsterdam"
        },
      • "billing": {
        • "postcode": "1234 AB",
        • "street": "Straat",
        • "houseNumber": "1",
        • "houseNumberExtension": "a",
        • "city": "Amsterdam"
        }
      },
    • "phone": "0612345678",
    • "email": "user@example.com",
    • "companyName": "companyName"
    },
  • "consent": {
    • "dataUsage": true,
    • "promotion": true,
    • "otherPromotion": true
    },
  • "context": {
    • "loggedBy": "integration",
    • "channel": "web",
    • "subChannel": "open",
    • "servicePartnerBranch": "servicePartnerA",
    • "requestType": "Advies",
    • "campaignName": "integration",
    • "brand": "brand",
    • "energyUsage": "energyUsage",
    • "productType": "productType",
    • "campaignId": "campaignId",
    • "website": "website"
    },
  • "metadata": {
    • "temperature": 4,
    • "createdOn": "2024-10-16T13:36:10.005Z",
    • "remarks": "remarks",
    • "source": "Online",
    • "environment": "Consument",
    • "leadTrackingId": "leadTrackingId",
    • "e2eTrackingId": "e2eTrackingId",
    • "gclid": "1234",
    • "referrer": "",
    • "reference": {
      • "postcode": "1234 AB",
      • "street": "Straat",
      • "houseNumber": "1",
      • "houseNumberExtension": "a",
      • "city": "Amsterdam",
      • "checkbox": true
      },
    • "adobeId": "adobeId",
    • "clickId": "clickId"
    },
  • "products": [
    • {
      • "category": "insulation",
      • "description": "insulation",
      • "subCategory": "roof",
      • "quantity": 1
      }
    ]
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "input_validation",
  • "message": "An instance of ApiBodyRequest has failed the validation:\n - property resourceId has failed the following constraints: isUuid \n"
}

Send F contract emails

Request Body schema: application/json
required
required
object

Header object

required
object

Request

Responses

Request samples

Content type
application/json
{
  • "header": {
    • "context": {
      • "brand": "energiedirect"
      }
    },
  • "request": {
    • "context": {
      • "agentId": "string",
      • "sourceSystem": "string"
      },
    • "letter": {
      • "letterCode": "F301",
      • "letterId": "string",
      • "letterSubject": "string",
      • "letterContent": {
        • "partner": {
          },
        • "sender": {
          }
        },
      • "documentData": "string"
      }
    }
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "input_validation",
  • "message": "An instance of ApiBodyRequest has failed the validation:\n - property resourceId has failed the following constraints: isUuid \n"
}

Send service (SNO) emails

Request Body schema: application/json
required
required
object

Request

Responses

Request samples

Content type
application/json
{
  • "request": {
    • "preferredCommunicationChannel": "EMAIL",
    • "context": {
      • "agentId": "12345",
      • "sourceSystem": "CRM"
      },
    • "letter": {
      • "letterId": "LID123",
      • "letterContent": {
        • "partner": {
          },
        • "futureEnergy": {
          }
        }
      }
    }
}

Response samples

Content type
application/json
{
  • "statusCode": 400,
  • "code": "input_validation",
  • "message": "An instance of ApiBodyRequest has failed the validation:\n - property resourceId has failed the following constraints: isUuid \n"
}

Generic

A lead order can be created, which a customer has to approve before it is picked up as a new customer request

Request Body schema: application/json
required
required
object (Order)

Responses

Request samples

Content type
application/json
{
  • "order": {
    • "OrderData": {
      • "Partner ID": "123456789",
      • "ExternalParty": {
        • "ID": "12345678"
        },
      • "ContactDate": "2024-07-15",
      • "PersonalDetails": {
        • "Initials": "D.",
        • "Prefix": "van",
        • "Lastname": "Surname",
        • "Birthdate": "1990-01-01",
        • "Gender": "Male"
        },
      • "SupplyAddress": {
        • "isResidential": true,
        • "addressInformation": {
          },
        • "connections": [
          ],
        • "marketProcessType": "switch_in",
        • "budgetBillAmount": 200,
        • "offer": {
          }
        },
      • "Correspondence": {
        • "contactPerson": "Kees Janssen",
        • "phoneNumber": "0612345678",
        • "emailAddress": "piet@hein.nl",
        • "correspondenceAddress": {
          }
        },
      • "PaymentDetails": {
        • "BankAccount": "NL91ABNA0417164300",
        • "PaymentMethod": "I"
        },
      • "Products": {
        • "E": {
          },
        • "G": {
          }
        },
      • "Campaign": {
        • "ID": "123",
        • "IncentiveID": "456"
        },
      • "Referer": "REFERER CODE"
      }
    }
}

Response samples

Content type
application/json
{
  • "status": "success"
}

optionsFormsubmitV2

Responses

Response samples

Content type
application/json
{
  • "error": {
    • "errorCode": "BAD_REQUEST",
    • "errorDateTime": "2020-08-18T15:00:25",
    • "errorMessage": "Undefined error message. Please, improve your error handling!",
    • "errorDescription": "Required query parameter export-id not specified"
    }
}

Submits form

Request Body schema: application/json
required
required
object (Request)
xmlBodyString
required
string

Full XML string from request for indexing

Responses

Request samples

Content type
application/json
{
  • "request": {
    • "ActivityReferenceID": "pvm:001g19s.4",
    • "ActivityName": "GetMeterReadings",
    • "Payload": [
      • {
        • "GetMeterReadingsRequest": [
          ],
        • "StartOutboundDisputeRequest": [
          ]
        }
      ],
    • "BusinessServiceReferenceID": "pvm:0a1019s",
    • "NextActivityReferenceID": "pvm:001g19s.4",
    • "NextActivityName": "GetMeterReadings",
    • "Status": "IN_PROGRESS"
    },
  • "xmlBodyString": "<root><body>example</body></root>"
}

Response samples

Content type
application/json
{
  • "ok": ""
}

Marketing

Querying aquisition score by address key

Request Body schema: application/json
required
required
Array of objects (GetAcquisitionScoreAddressRequest) <= 100 items

Responses

Request samples

Content type
application/json
{
  • "addresses": [
    • {
      • "delivery_address_key": "1234AB_56_C"
      }
    ]
}

Response samples

Content type
application/json
{
  • "profiles": [
    • {
      • "acquisition_score": "medium",
      • "acquisition_score_sme": "medium",
      • "delivery_address_key": "1234AB_56_C"
      }
    ]
}

Send feedback to either offerstore or action store. This endpoint accepts either an offer id or an action id, your request will be routed to the offer store and action store accordingly The feedback type can be either offerstore feedback or action feedback, depending on the actionId or offerId you will need to send in correct feedback

Request Body schema: application/json
required
offerId
string <uuid>

The offer id to submit feedback for. Either this or the action id is required

actionId
string <uuid>

The offer id to submit feedback for. Either this or the offer id is required

feedbackType
required
string
Enum: "rejected" "clicked" "banner_clicked" "offer_clicked" "shown" "returned"

The type of feedback

profileId
required
string <uuid>

The profile id the feedback is applicable for

channel
any

The channel you're sending the feedback for, if you are calling this API from a specific application (eg. Mijn and Cockpit) this will be inferred from your API Key.

object (PostFeedbackMetadata)
correlationId
string <uuid>

Id used to correlate nextbestaction and nextbestoffer calls with subsequent feedback calls

Responses

Request samples

Content type
application/json
{
  • "offerId": "52eef6a0-b1ac-4af7-aab1-a20273a2e850",
  • "actionId": "52eef6a0-b1ac-4af7-aab1-a20273a2e850",
  • "feedbackType": "clicked",
  • "profileId": "52eef6a0-b1ac-4af7-aab1-a20273a2e850",
  • "channel": "mijn",
  • "metadata": {
    • "incentiveId": "52eef6a0-b1ac-4af7-aab1-a20273a2e850",
    • "flowId": "52eef6a0-b1ac-4af7-aab1-a20273a2e850"
    },
  • "correlationId": "8c9250cc-370b-444a-8a8e-4dad1148cf7a"
}

Response samples

Content type
application/json
{
  • "accepted": true,
  • "resourceId": "6816ebfd-9c4d-47d8-81a9-01057dc25540"
}

Metering

This API retrieves expected consumption for a given Address

query Parameters
postcode
required
string^[0-9]{4}[\s]?[A-Za-z]{2}$
Example: postcode=1234 BB

Valid Dutch Postal code with or without space

house_number
required
string^[0-9]{1,5}$
Example: house_number=23

House number of the address

vacancy
required
boolean
Example: vacancy=true

indicate if the house is vacant

residents
required
string
Enum: "ONE" "TWO" "THREE" "FOUR" "FIVE" "SIX" 1 2 3 4 5 6
Example: residents=3

Number of people in the house

house_number_extension
string^[A-Za-z]{1,6}$
Example: house_number_extension=F

House number extension of the address

Responses

Response samples

Content type
application/json
{
  • "gas": 15,
  • "electricity": {
    • "total": 15,
    • "high": 15,
    • "low": 15
    }
}

This API retrieves expected consumption for a given houseType

query Parameters
house_type
required
string (HouseType)
Enum: "vrijstaand" "2onder1kap" "hoek" "rijtje" "appartement"

The type of house

residents
required
string (Residents)
Enum: "ONE" "TWO" "THREE" "FOUR" "FIVE" "SIX" 1 2 3 4 5 6

The number of residents for a house

Responses

Response samples

Content type
application/json
{
  • "gas": 15,
  • "electricity": {
    • "total": 15,
    • "high": 15,
    • "low": 15
    }
}

Ocpi

Check service availability

Responses

Response samples

Content type
application/json
{
  • "success": true
}

getCdr_v1

EIG will be able to request enriched CDR's from us.

path Parameters
cdr_id
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "data": {
    • "id": "string",
    • "start_date_time": "2019-08-24T14:15:22Z",
    • "stop_date_time": "2019-08-24T14:15:22Z",
    • "auth_id": "string",
    • "auth_method": "AUTH_REQUEST",
    • "location": {
      • "id": "string",
      • "type": "ON_STREET",
      • "name": "string",
      • "address": "string",
      • "city": "string",
      • "postal_code": "string",
      • "country": "str",
      • "coordinates": {
        • "latitude": "string",
        • "longitude": "string"
        },
      • "evses": [
        • {
          }
        ],
      • "last_updated": "string"
      },
    • "meter_id": "string",
    • "currency": "str",
    • "tariffs": [
      • {
        • "id": "string",
        • "currency": "str",
        • "elements": [
          ],
        • "last_updated": "2019-08-24T14:15:22Z"
        }
      ],
    • "charging_periods": [
      • {
        • "start_date_time": "2019-08-24T14:15:22Z",
        • "dimensions": [
          ]
        }
      ],
    • "total_cost": 0,
    • "total_energy": 0,
    • "total_time": 0,
    • "total_parking_time": 0,
    • "remark": "string",
    • "last_updated": "2019-08-24T14:15:22Z"
    },
  • "status_code": 1000,
  • "status_message": "Success",
  • "timestamp": "2021-01-01T00:00:00Z"
}

getEmspCdr_v1

EMSPs are able to request enriched CDR's from us through EIG.

query Parameters
date_from
string <date-time>
date_to
string <date-time>
offset
required
integer
Default: 0
limit
required
integer
Default: 200
header Parameters
x-emp
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "start_date_time": "2019-08-24T14:15:22Z",
      • "stop_date_time": "2019-08-24T14:15:22Z",
      • "auth_id": "string",
      • "auth_method": "AUTH_REQUEST",
      • "location": {
        • "id": "string",
        • "type": "ON_STREET",
        • "name": "string",
        • "address": "string",
        • "city": "string",
        • "postal_code": "string",
        • "country": "str",
        • "coordinates": {
          },
        • "evses": [
          ],
        • "last_updated": "string"
        },
      • "meter_id": "string",
      • "currency": "str",
      • "tariffs": [
        • {
          }
        ],
      • "charging_periods": [
        • {
          }
        ],
      • "total_cost": 0,
      • "total_energy": 0,
      • "total_time": 0,
      • "total_parking_time": 0,
      • "remark": "string",
      • "last_updated": "2019-08-24T14:15:22Z"
      }
    ],
  • "status_code": 1000,
  • "status_message": "Success",
  • "timestamp": "2021-01-01T00:00:00Z"
}

getToken_v1

If the eMSP wants to check the status of a Token in the CPO system it might GET the object from the CPO system for validation purposes. The eMSP is the owner of the objects, so it would be illogical if the CPO system had a different status or was missing an object

path Parameters
country_code
required
string = 2 characters
party_id
required
string = 3 characters
object_id
required
string <= 64 characters

Responses

Response samples

Content type
application/json
{
  • "status_code": 1000,
  • "status_message": "Success",
  • "timestamp": "2021-01-01T00:00:00Z",
  • "data": {
    • "uid": "012345678",
    • "type": "RFID",
    • "auth_id": "DE8ACC12E46L89",
    • "visual_number": "DF000-2001-8999",
    • "issuer": "TheNewMotion",
    • "valid": true,
    • "whitelist": "ALWAYS",
    • "last_updated": "2021-01-01T00:00:00Z"
    }
}

postCdr_v1

EIG proxy will send CDRs to us to enrich with tariff data before sending to the eMSP, this endpoint does not return the enriched data, but only a success message. We will call EIG with the enriched data after processing.

Request Body schema: application/json
required
id
required
string <= 36 characters
start_date_time
required
string <date-time>
stop_date_time
required
string <date-time>
auth_id
required
string <= 36 characters
auth_method
required
string
Enum: "AUTH_REQUEST" "WHITELIST"
required
object
meter_id
string <= 255 characters
currency
required
string = 3 characters
required
Array of objects non-empty
total_cost
required
number
total_energy
required
number
total_time
required
number
total_parking_time
number
remark
string <= 255 characters
last_updated
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "start_date_time": "2019-08-24T14:15:22Z",
  • "stop_date_time": "2019-08-24T14:15:22Z",
  • "auth_id": "string",
  • "auth_method": "AUTH_REQUEST",
  • "location": {
    • "id": "string",
    • "type": "ON_STREET",
    • "name": "string",
    • "address": "string",
    • "city": "string",
    • "postal_code": "string",
    • "country": "str",
    • "coordinates": {
      • "latitude": "string",
      • "longitude": "string"
      },
    • "evses": [
      • {
        • "uid": "string",
        • "evse_id": "string",
        • "status": "AVAILABLE",
        • "connectors": [
          ],
        • "last_updated": "2019-08-24T14:15:22Z"
        }
      ],
    • "last_updated": "string"
    },
  • "meter_id": "string",
  • "currency": "str",
  • "charging_periods": [
    • {
      • "start_date_time": "2019-08-24T14:15:22Z",
      • "dimensions": [
        • {
          }
        ]
      }
    ],
  • "total_cost": 0,
  • "total_energy": 0,
  • "total_time": 0,
  • "total_parking_time": 0,
  • "remark": "string",
  • "last_updated": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "status_code": 1000,
  • "status_message": "Success",
  • "timestamp": "2021-01-01T00:00:00Z"
}

putToken_v1

New or updated Token objects are pushed from the eMSP to the CPO

path Parameters
country_code
required
string = 2 characters
party_id
required
string = 3 characters
object_id
required
string <= 64 characters
Request Body schema: application/json
required
uid
required
string <= 36 characters
type
required
string (TokenType)
Enum: "RFID" "OTHER"
auth_id
required
string <= 36 characters
visual_number
string <= 64 characters
issuer
required
string <= 64 characters
valid
required
boolean
whitelist
required
string (WhiteListType)
Enum: "ALWAYS" "ALLOWED" "ALLOWED_OFFLINE" "NEVER"
language
string <= 2 characters
last_updated
required
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "uid": "012345678",
  • "type": "RFID",
  • "auth_id": "DE8ACC12E46L89",
  • "visual_number": "DF000-2001-8999",
  • "issuer": "TheNewMotion",
  • "valid": true,
  • "whitelist": "ALWAYS",
  • "last_updated": "2021-01-01T00:00:00Z"
}

Response samples

Content type
application/json
{
  • "status_code": 1000,
  • "status_message": "Success",
  • "timestamp": "2021-01-01T00:00:00Z"
}

Outbound Sales

Place a sale

header Parameters
client_id
required
string
Example: 87f55dc1-8ee9-45ff-b285-6e4f5add478c

The client id that is used for authentication

Request Body schema: application/json
required
registrationTimestamp
required
string <date-time>

Timestamp when the sale was made by the sales partner

existingAccountId
string = 10 characters ^\d*$

AccountID

required
object (Organisation)
required
Array of objects (SupplyAddress) non-empty
required
object (Metadata)
saleType
required
string
Enum: "retention" "acquisition"

Type of sale, also referred to as funnelType. This is the type of offer / campaign that has been offered

combideal
boolean

Whether this is a combideal offering. Not required to send in in case it is not.

Responses

Request samples

Content type
application/json
{
  • "registrationTimestamp": "2023-11-09T13:33:11+02:00",
  • "existingAccountId": "1234567890",
  • "organisation": {
    • "name": "Essent",
    • "kvk": "12345678",
    • "legalEntity": "union",
    • "paymentInformation": {
      • "iban": "NL91ABNA0417164300",
      • "paymentMethod": "manual",
      • "invoiceAddress": {
        • "addressType": "pobox_address",
        • "poBox": "90222",
        • "postalCode": "1234AA",
        • "city": "Boskoop",
        • "country": "NL"
        }
      },
    • "correspondenceDetails": {
      • "contactPerson": "Kees Janssen",
      • "phoneNumber": "0612345678",
      • "emailAddress": "piet@hein.nl",
      • "correspondenceAddress": {
        • "addressType": "pobox_address",
        • "poBox": "90222",
        • "postalCode": "1234AA",
        • "city": "Boskoop",
        • "country": "NL"
        }
      }
    },
  • "supplyAddresses": [
    • {
      • "isResidential": true,
      • "addressInformation": {
        • "houseNumber": "12",
        • "houseNumberExtension": "a",
        • "postalCode": "1234AA",
        • "street": "Amsterdamsestraat",
        • "city": "Boskoop"
        },
      • "connections": [
        • {
          }
        ],
      • "marketProcessType": "switch_in",
      • "budgetBillAmount": 200,
      • "offer": {
        • "campaignId": "233531",
        • "incentiveId": "61246",
        • "offerId": "4a820b0f-5e06-43a2-a50e-072c51e9ff7a",
        • "duration": "F",
        • "tariffDate": "2023-10-01"
        }
      }
    ],
  • "metadata": {
    • "externalIdentifier": "8ea1a0df-166d-4a41-854a-4dd0ad1a8baa"
    },
  • "saleType": "acquisition",
  • "combideal": true
}

Response samples

Content type
application/json
{
  • "saleId": "5968d25f-becc-4c41-ae09-3ea5d9849925",
  • "warnings": [
    • {
      • "code": "INVALID_BBA_AMOUNT",
      • "message": "The budget bill amount for address 1234AA, 23 was smaller than the minimum amount of 25 euros per connection. This has been automatically adjusted to 0 as per the agreement."
      }
    ]
}

Partner

getA2aRem

path Parameters
resource
required
string
ver
required
string
header Parameters
client_id
required
string

The client identifier which is appended after authentication at the API Gateway.

partnerkey
required
string

The partnerkey which is directly provided by the sales partner.

Responses

Response samples

Content type
application/json
{
  • "error": {
    • "errorCode": "BAD_REQUEST",
    • "errorDateTime": "2020-08-18T15:00:25",
    • "errorMessage": "Undefined error message. Please, improve your error handling!",
    • "errorDescription": "Required query parameter export-id not specified"
    }
}

Salespartners

Gets meter details from SAP IS-U and if not available reaches out to the CAR (Central Connection Register) via EDSN

query Parameters
postcode
required
string
Example: postcode=1234 BB

Valid Dutch Postal code with or without space

house_number
string^[1-9]\d*$
Example: house_number=23

House number

house_number_extension
string
Example: house_number_extension=A

House number extension of address

connect_ean
string [ 12 .. 18 ] characters ^\d+$
Example: connect_ean=000000000000

EAN code of the consumer

phase
string
Enum: "identification" "offer" "pre-mutation"
Example: phase=identification

Customer journey process phase. Values - identification{when query parameters postcode,house_number,house_number_extension are present }, offer {when query parameter connect_ean is present}, pre-mutation{when query parameter connect_ean is present

header Parameters
CustomerConsent
string <base64>
Example: eyJjdXN0b21lcl9jb25zZW50Ijp7Im5hbWUiOiJULkUuUy5ULiAgVGVzdCIsImliYW5fa2V5IjoiMTExIn19

CustomerConsent as base64 encoded JSON string. Refer the customer_consent data model. base64encoded({ "customer_consent" { "name" "Rohit Deshpande", "birthday_key" "--12-31", "iban_key" "123", "consent_date" "2017-12-31", "consent_type" "Get Start Date" } })

Responses

Response samples

Content type
application/json
{
  • "response": {
    • "messages": [
      • {
        • "type": "S",
        • "code": "200",
        • "message": "Success"
        }
      ],
    • "data": {
      • "consent_id": "eyJjdXN0b21lcl9jb25zZW50Ijp7Im5hbWUiOiJULkUuUy5ULiAgVGVzdCIsImliYW5fa2V5IjoiMTExIn19",
      • "connections": [
        • {
          }
        ]
      }
    }
}

Util

This service is used to autocomplete the address details

query Parameters
house_number
required
string^[0-9]\d{0,5}$
Example: house_number=183

House number

postcode
required
string^[1-9]\d{3} ?[A-Z]{2}$
Example: postcode=5223 KE

Postal code

Responses

Response samples

Content type
application/json
{
  • "address": {
    • "street": "Willemsplein",
    • "city": "'S-HERTOGENBOSCH",
    • "country": "2"
    }
}