API docs by Redocly

External APIs (1.0)

Download OpenAPI specification:Download

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

header Parameters
client-name
string
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"
    }
}

Response samples

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

Complete the new customer flow.

header Parameters
client-name
string
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"
        }
      },
    • "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"
    }
}

Response samples

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

Creates an order for a customer

header Parameters
client-name
string
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": "Netherlands"
    },
  • "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": "Netherlands"
      },
    • "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"
      }
    }
}

Response samples

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

Creates or updates personal details of a new customer

header Parameters
client-name
string
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"
    }
}

Response samples

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

getInstallationdetailsV2

Get a collection of a v2.

Responses

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "77bde5f0-98fd-4a0d-894d-06a4a0b93eda"
    },
  • "payload": [
    • {
      • "energy_type": "electricity",
      • "installations": [
        • {
          }
        ]
      }
    ]
}

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": {
          }
        }
      }
    ]
}

getStartdateV2

This Service retrieves possible start dates.

Responses

Response samples

Content type
application/json
{
  • "value": {
    • "meta_data": {
      • "flow_id": "77bde5f0-98fd-4a0d-894d-06a4a0b93eda"
      },
    • "payload": [
      • {
        • "energy_type": "gas",
        • "possible_start_dates": [
          ],
        • "selected_start_date": "2022-09-12",
        • "contract_end_date": "2022-09-12",
        • "limits": {
          }
        }
      ]
    }
}

getSummaryV2

Get a collection of a v2.

Responses

Response samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "655c7f89-48cf-48c8-9ab4-ec64fc96f332"
    },
  • "payload": {
    • "supply_address": {
      • "postcode": "1234 AB",
      • "house_number": "10",
      • "house_number_extension": "a",
      • "street": "Churchstreet",
      • "city": "Funkytown"
      },
    • "segment_details": {
      • "customer_segment": "household",
      • "customer_sub_segment": "housing_association"
      },
    • "correspondence_address": {
      • "house_number": "10",
      • "postcode": "1577FH",
      • "house_number_extension": "1B",
      • "street": "Koningsweg",
      • "city": "Den-Bosch",
      • "care_of_fullname ": "A. Jasleen"
      },
    • "payment_details": {
      • "iban": "NL63ABNA0615407293",
      • "incoming_payment_method": "manual"
      },
    • "communication_details": {
      • "preferred_channel": "email"
      },
    • "products": [
      • {
        • "id": "string",
        • "description": "string",
        • "duration_in_years": "2",
        • "energy_type": "electricity"
        }
      ],
    • "start_date_details": [
      • {
        • "energy_type": "electricity",
        • "start_date": "2018-07-12",
        • "is_cooldown_applicable": true
        }
      ]
    }
}

putAdditionalinformationV3

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": {
    • "residential": true,
    • "contract_with_another_supplier": true,
    • "complex": true,
    • "contact_date": "2023-05-23"
    }
}

Response samples

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

putConsumptionV2

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

Request Body schema: application/json
optional
required
object
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "77bde5f0-98fd-4a0d-894d-06a4a0b93eda"
    },
  • "payload": [
    • {
      • "energy_type": "electricity",
      • "standard_annual_usages": [
        • {
          }
        ]
      }
    ]
}

Response samples

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

putPropositionV2

Update an v2 based on information provided.

Request Body schema: application/json
optional
required
object
required
object

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"
    }
}

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"
    }
}

putRspcancellationV1

Update an v1 based on information provided.

Request Body schema: application/json
optional
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "meta_data": {
    • "flow_id": "77bde5f0-98fd-4a0d-894d-06a4a0b93eda"
    },
  • "payload": {
    • "breakoffreason": "Niet mogelijk op aansluiting/ onvindbaar"
    }
}

Response samples

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

Retrieve correspondence details of flow

header Parameters
client-name
string
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": {
      • "city": "Den bosch",
      • "postcode": "1234 BB",
      • "street": "Langeweg",
      • "house_number": "23",
      • "house_number_extension": "A",
      • "care_of_full_name": "Johannes Vermeer",
      • "pobox": "71"
      }
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    }
}

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

header Parameters
client-name
string

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

header Parameters
client-name
string
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"
    }
}

Response samples

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

Saves organisation details of a flow.

header Parameters
client-name
string
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"
    }
}

Response samples

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

Saves the ean details to the cache

header Parameters
client-name
string
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"
    }
}

Response samples

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

Set the payment details of the flow

header Parameters
client-name
string
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": {
      • "city": "Den bosch",
      • "postcode": "1234 BB",
      • "street": "Langeweg",
      • "house_number": "23",
      • "house_number_extension": "A",
      • "care_of_full_name": "Johannes Vermeer",
      • "pobox": "71"
      }
    },
  • "meta_data": {
    • "flow_id": "f58cf010-38ab-4b8e-87f5-ead9b3833ad5"
    }
}

Response samples

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

Set the start date of the contract

header Parameters
client-name
string
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"
    }
}

Response samples

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

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

header Parameters
client-name
string
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"
    }
}

Response samples

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

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

header Parameters
client-name
string

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"
    }
}

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

header Parameters
client-name
string
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

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"
    ]
}

Response samples

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

Change Contract

Puts the confirmation of the change in the contract

header Parameters
external-partner-id
string
Example: 132406992

The external partner Id

client-name
string
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"
    },
  • "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

header Parameters
client-name
string
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"
    },
  • "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

header Parameters
client-name
string

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"
        }
      }
    ]
}

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

header Parameters
client-name
string

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

header Parameters
client-name
string

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

header Parameters
client-name
string
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

header Parameters
client-name
string
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": {
    • "use_supply_address": true,
    • "phone": "+31617171717",
    • "preferred_channel": "email",
    • "correspondence_address": {
      • "city": "Den bosch",
      • "postcode": "1234 BB",
      • "street": "Langeweg",
      • "house_number": "23",
      • "house_number_extension": "A",
      • "care_of_full_name": "Johannes Vermeer",
      • "pobox": "71"
      }
    }
}

Response samples

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

This API saves the payment details for a customer

header Parameters
client-name
string
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"
    },
  • "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

header Parameters
client-name
string
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"
    },
  • "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

header Parameters
client-name
string

Responses

Response samples

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

Contracting

putDocumentproofV1

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

Request Body schema: application/json
optional
required
object
external_partner_id
required
string [ 3 .. 10 ] characters ^[a-zA-Z0-9]+$
required
object

Responses

Request samples

Content type
application/json
{
  • "external_partner_id": "IMP",
  • "sale_details": {
    • "order_id": "93c48710-4c6a-45db-8e8d-94c83bf24a1f",
    • "date": "2021-05-25",
    • "address": {
      • "postcode": "1577FH",
      • "house_number": "10",
      • "house_number_extension": "A",
      • "street": "Koningsweg",
      • "city": "Den-Bosch",
      • "country_code": "NL"
      }
    },
  • "proof_details": {
    • "type": "burden_of_proof",
    • "source": "sales_partner",
    • "acquired_date": "2021-05-25",
    • "expiry_date": "2022-06-01",
    • "proof": {
      • "document": {
        • "type": "pdf",
        • "content": "JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeQowMDAwMDAyMDkwIDAwMDAwIG4NCjAwMDAwMjYwMTggMDAwMDAgbg0KMDAwMDAyOTE2NiAwMDAwMCBuDQowMDAwMDI5MjExIDAwMDAwIG4NCnRyYWlsZXINCjw8L1NpemUgMjMvUm9vdCAxIDAgUi9JbmZvIDkgMCBSL0lEWzw3MTI5MDVFNDNEQzIwRDQ5QTE3N0MyMEMyNEI5QUM1MT48NzEyOTA1RTQzREMyMEQ0OUExNzdDMjBDMjRCOUFDNTE+XSA+Pg0Kc3RhcnR4cmVmDQoyOTQ5Ng0KJSVFT0YNCnhyZWYNCjAgMA0KdHJhaWxlcg0KPDwvU2l6ZSAyMy9Sb290IDEgMCBSL0luZm8gOSAwIFIvSURbPDcxMjkwNUU0M0RDMjBENDlBMTc3QzIwQzI0QjlBQzUxPjw3MTI5MDVFNDNEQzIwRDQ5QTE3N0MyMEMyNEI5QUM1MT5dIC9QcmV2IDI5NDk2L1hSZWZTdG0gMjkyMTE+Pg0Kc3RhcnR4cmVmDQozMDExMg0KJSVFT0Y="
        }
      }
    }
}

Response samples

Content type
application/json
{
  • "document_id": "ED$NOTSET$44403533$2$NOTSET"
}

Emobility

Charge station lead endpoint for external partners

Request Body schema: application/json
required
external_partner_id
required
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 (SalesPartnerChargeStationDetails)
object (SalesPartnerPaymentDetails)
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

Responses

Request samples

Content type
application/json
{
  • "external_partner_id": "4be41f9d-1e9e-4d30-bb20-8a91c06ab37d",
  • "product_type": "charge-card",
  • "charge_station": {
    • "model": "s-line"
    },
  • "payment_details": {
    • "iban": "NL91ABNA0417164300",
    • "account_holder": "J. Jansen."
    },
  • "business_details": {
    • "organization_name": "Essent B.V.",
    • "chamber_of_commerce_number": "17115973"
    },
  • "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"
    },
  • "campaign_id": "4be41f9d-1e9e-4d30-bb20-8a91c06ab37d"
}

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"
}

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.

header Parameters
client-name
string
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"

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 [ 1 .. 1000 ] characters

Any additional remarks

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"
    },
  • "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"
}

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

header Parameters
client-name
string
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"
}

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
Channel
number
CarCerConsent
boolean
object (marketing)
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",
  • "Channel": 2,
  • "CarCerConsent": true,
  • "Marketing": {
    • "LeadId": "84251",
    • "LeadIdEssent": "14A28U4142"
    },
  • "Organization": {
    • "Name": "Essent Test Request",
    • "Kvk": "09118704",
    • "BusinessPartnerNumber": "287489542",
    • "LegalStructure": 1,
    • "Payment": {
      • "BankAccount": "NL65INGB0000000111",
      • "PaymentMethod": 2
      },
    • "Contact": {
      • "message": "Message"
      },
    • "Agreements": [
      • {
        • "IsResidential": true,
        • "ContractDuration": 36,
        • "SupplyAddress": {
          },
        • "Product": 8,
        • "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"
}

Generic

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

header Parameters
client-name
string
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": {
    • "content": {
      • "field": [
        • {
          }
        ]
      },
    • "context": {
      • "field": [
        • {
          }
        ]
      },
    • "header": {
      • "flow": {
        • "attributes": {
          }
        }
      }
    },
  • "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" "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)

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"
    }
}

Response samples

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

Send offer feedback to the OfferStore Deprecated

path Parameters
offerId
required
string <uuid>
Example: 780e2de9-f3f3-4feb-967e-357543a5a8b0

UUID of the offer.

Request Body schema: application/json
required
object (OfferFeedbackMetadataV2)
channel
string
Enum: "facebook" "google" "pcw" "app" "open" "mijn" "cockpit" "external_partner" "daisycon" "sales_portal" "chatbot"

Channel for the feedback

eventType
required
string
Enum: "offer_returned" "offer_shown" "client_not_interested" "client_interested" "offer_accepted" "fulfillment_started" "prospect_id_known" "customer_id_known" "contract_id_known" "fulfillment_stage_1" "fulfillment_stage_2" "fulfillment_stage_3" "fulfillment_stage_4" "fulfillment_cancelled" "cooldown_started" "cooldown_expired" "fulfillment_completed" "shown" "clicked" "rejected" "returned"

The stage of the offer.

notInterestedReason
string
Enum: "not_interested" "wants_to_wait" "happy_with_current_supplier" "tariffs_too_high" "preconditions_unmet" "installation_not_found" "used_different_channel" "long_term_unwanted" "development_impossible" "details_dont_match" "other"

Required when eventType is CLIENT_NOT_INTERESTED. Feedback for the offer in case they were not interested.

fulfillmentCancelledReason
string

Required when eventType is FULFILLMENT_CANCELLED. Feedback for the offer in case they cancelled.

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    • "incentiveId": "f1a083b7-100d-4401-afbd-998ad26b2db9",
    • "flowId": "448700"
    },
  • "channel": "cockpit",
  • "eventType": "offer_accepted",
  • "notInterestedReason": "wants_to_wait",
  • "fulfillmentCancelledReason": "Customer is moving."
}

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

header Parameters
client-name
string

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
Enum: "vrijstaand" "2onder1kap" "hoek" "rijtje" "appartement"
Example: house_type=appartement

The type of house

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

The number of residents for a house

header Parameters
client-name
string

Responses

Response samples

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

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" } })

client-name
string

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

header Parameters
client-name
string

Responses

Response samples

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