Retrieve rebate evidence file details

Carbon

Endpoints for interacting with carbon intensity data.

SchemasOperations

Charging Sessions

Endpoints related to records of charging.

SchemasOperationsWebhooks

CSV

Endpoints that return CSV responses only and are not linkable to other endpoint data.

EVSEs

Endpoints for interacting with EVSEs.

SchemasOperations

Notifications

Endpoints for communicating notifications.

Operations

Programs

Endpoints related to incentivised charging programs.

Operations

Rebates

Endpoints for interacting with rebates.

SchemasOperations

UserRebateCreated

Resource representing a newly created UserRebate object.

idstringread-only

UID of the new UserRebate object.

urlstring(uri)read-only

{
  "id": "rbtuB1USP6YGD1VPIDJSHTZARUX11M",
  "url": "https://api.ev.energy/v2/user_rebates/rbtuB1USP6YGD1VPIDJSHTZARUX11M"
}

List Rebate Types

Request

Retrieve a list of rebate types available to the user.

Security

oauth2

Query

expandArray of strings

Specify a url field to expand into a nested resource.

Items Value"required_evidence"

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/rebate_types?expand=required_evidence' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Return a list of rebate types.

Headers

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default 1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default 999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default 3600

Bodyapplication/jsonArray [

idstringread-only

Unique identifier for the RebateType

Example: "rbttB1USP6YGD1VPIDJSHTZARUX11M"

urlstring(uri)read-only

Example: "https://api.ev.energy/v2/rebate_types/rbttB1USP6YGD1VPIDJSHTZARUX11M"

titlestringread-only

Display name.

Example: "Vehicle Enrollment"

value_descriptionstringread-only

Short text describing the rebate value.

Example: "earn up to $1000"

iconstring or null(uri)read-only

URI for an icon representing this rebate type.

Example: "https://example.com"

description_longstring or nullread-only

Describes the rebate type.

Example: "Rebate for purchasing an eligible vehicle."

description_shortstring or nullread-only

One line of text containing important information for the rebate type.

Example: "Must be purchased after 11/01/2024"

requirementsstring(html)read-only

HTML string containing detailed eligibility requirements.

Example: "<html><ul><li>Must be eligible for program</li><li>Purchased after 11/01/2024</li><li>Must be connected to ev.energy</li></ul></html>"

required_evidenceArray of RebateEvidenceType (object) or strings

Example: [{"title":"string","description":"string","upload_required":true,"file":{"name":"string","url":"https://example.com"},"evidence_data":[{"data_type":"currency","title":"string","description":"string","required":true,"value":"string"}]}]

]

Response

application/json

[
  {
    "$ref": "#/components/examples/RebateType"
  }
]

Retrieve rebate type

Request

Retrieve a specific rebate type by id.

Security

oauth2

Path

rebate_type_idstringrbtt[A-Z\d]{26}required

ID of the requested rebate type

Example: rbttB1USP6YGD1VPIDJSHTZARUX11M

Query

expandArray of strings

Specify a url field to expand into a nested resource.

Items Value"required_evidence"

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

Accept-Languagestring

Indicates the natural language and locale that the client prefers.

curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/rebate_types/rbttB1USP6YGD1VPIDJSHTZARUX11M?expand=required_evidence' \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

OK

Headers

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default 1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default 999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default 3600

Bodyapplication/json

idstringread-only

Unique identifier for the RebateType

Example: "rbttB1USP6YGD1VPIDJSHTZARUX11M"

urlstring(uri)read-only

Example: "https://api.ev.energy/v2/rebate_types/rbttB1USP6YGD1VPIDJSHTZARUX11M"

titlestringread-only

Display name.

Example: "Vehicle Enrollment"

value_descriptionstringread-only

Short text describing the rebate value.

Example: "earn up to $1000"

iconstring or null(uri)read-only

URI for an icon representing this rebate type.

Example: "https://example.com"

description_longstring or nullread-only

Describes the rebate type.

Example: "Rebate for purchasing an eligible vehicle."

description_shortstring or nullread-only

One line of text containing important information for the rebate type.

Example: "Must be purchased after 11/01/2024"

requirementsstring(html)read-only

HTML string containing detailed eligibility requirements.

Example: "<html><ul><li>Must be eligible for program</li><li>Purchased after 11/01/2024</li><li>Must be connected to ev.energy</li></ul></html>"

required_evidenceArray of RebateEvidenceType (object) or strings

Example: [{"title":"string","description":"string","upload_required":true,"file":{"name":"string","url":"https://example.com"},"evidence_data":[{"data_type":"currency","title":"string","description":"string","required":true,"value":"string"}]}]

Response

application/json

{
  "id": "rbttB1USP6YGD1VPIDJSHTZARUX11M",
  "url": "https://api.ev.energy/v2/rebate_types/rbttB1USP6YGD1VPIDJSHTZARUX11M",
  "title": "Vehicle Enrollment",
  "value_description": "earn up to $1000",
  "icon": "https://example.com",
  "description_long": "Rebate for purchasing an eligible vehicle.",
  "description_short": "Must be purchased after 11/01/2024",
  "requirements": "<html><ul><li>Must be eligible for program</li><li>Purchased after 11/01/2024</li><li>Must be connected to ev.energy</li></ul></html>",
  "required_evidence": [
    { … }
  ]
}

List Rebate Evidence Types

Request

Retrieve a list of rebate types available to the user.

Security

oauth2

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

curl -i -X GET \
  https://developers.ev.energy/_mock/ev.energy-api-v2/rebate_evidence_types \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Return a list of rebate evidence types.

Headers

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default 1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default 999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default 3600

Bodyapplication/jsonArray [

idstringrbet[A-Z\d]{26}read-only

Example: "rbetB1USP6YGD1VPIDJSHTZARUX11M"

urlstring(uri)read-only

Example: "https://api.ev.energy/v2/rebate_evidence_types/rbetB1USP6YGD1VPIDJSHTZARUX11M"

titlestringrequired

descriptionstring or nullrequired

upload_requiredbooleanrequired

Whether we require the user to upload a file.

fileobject or null

File uploaded by user as evidence.

evidence_dataArray of objects(RebateEvidenceSupportingData)required

evidence_data[].data_typeanyrequired

Enum"currency""string"

evidence_data[].titlestringrequired

Example: "Invoice"

evidence_data[].descriptionstringrequired

Example: "An invoice for solar panel installation"

evidence_data[].requiredbooleanrequired

Whether this data is required.

evidence_data[].valuestring or null

Value entered in the user's application.

]

Response

application/json

[
  {
    "id": "rbetB1USP6YGD1VPIDJSHTZARUX11M",
    "url": "https://api.ev.energy/v2/rebate_evidence_types/rbetB1USP6YGD1VPIDJSHTZARUX11M",
    "title": "string",
    "description": "string",
    "upload_required": true,
    "file": { … },
    "evidence_data": [ … ]
  }
]

Retrieve rebate evidence type

Request

Retrieve a specific rebate evidence type by id.

Security

oauth2

Path

rebate_evidence_type_idstringrbet[A-Z\d]{26}required

ID of the requested rebate evidence type

Example: rbetB1USP6YGD1VPIDJSHTZARUX11M

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

Accept-Languagestring

Indicates the natural language and locale that the client prefers.

curl -i -X GET \
  https://developers.ev.energy/_mock/ev.energy-api-v2/rebate_evidence_types/rbetB1USP6YGD1VPIDJSHTZARUX11M \
  -H 'Accept-Language: string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

OK

Headers

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default 1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default 999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default 3600

Bodyapplication/json

idstringrbet[A-Z\d]{26}read-only

Example: "rbetB1USP6YGD1VPIDJSHTZARUX11M"

urlstring(uri)read-only

Example: "https://api.ev.energy/v2/rebate_evidence_types/rbetB1USP6YGD1VPIDJSHTZARUX11M"

titlestringrequired

descriptionstring or nullrequired

upload_requiredbooleanrequired

Whether we require the user to upload a file.

fileobject or null

File uploaded by user as evidence.

evidence_dataArray of objects(RebateEvidenceSupportingData)required

evidence_data[].data_typeanyrequired

Enum"currency""string"

evidence_data[].titlestringrequired

Example: "Invoice"

evidence_data[].descriptionstringrequired

Example: "An invoice for solar panel installation"

evidence_data[].requiredbooleanrequired

Whether this data is required.

evidence_data[].valuestring or null

Value entered in the user's application.

Response

application/json

{
  "id": "rbetB1USP6YGD1VPIDJSHTZARUX11M",
  "url": "https://api.ev.energy/v2/rebate_evidence_types/rbetB1USP6YGD1VPIDJSHTZARUX11M",
  "title": "string",
  "description": "string",
  "upload_required": true,
  "file": {
    "name": "string",
    "url": "http://example.com"
  },
  "evidence_data": [
    { … }
  ]
}

Create rebate application

Request

Creates a rebate application, returning the application ID.

Security

oauth2

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example: user01HN2NJ9NMRZBXT1H6FT9N7735

Bodyapplication/json

rebate_typestringrequired

Rebate type resource uri

Example: "https://api.ev.energy/v2/rebate_types/rbttB1USP6YGD1VPIDJSHTZARUX11M"

curl -i -X POST \
  https://developers.ev.energy/_mock/ev.energy-api-v2/user_rebates \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2' \
  -d '{
    "rebate_type": "https://api.ev.energy/v2/rebate_types/rbttB1USP6YGD1VPIDJSHTZARUX11M"
  }'

Responses

Created

Headers

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default 1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default 999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default 3600

Bodyapplication/json

idstringread-only

UID of the new UserRebate object.

urlstring(uri)read-only

Response

application/json

{
  "id": "rbtuB1USP6YGD1VPIDJSHTZARUX11M",
  "url": "https://api.ev.energy/v2/user_rebates/rbtuB1USP6YGD1VPIDJSHTZARUX11M"
}

List rebate applications

Request

Lists all a user's rebate applications.

Security

oauth2

Query

expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum"rebate_type""rebate_type.required_evidence"

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example: user01HN2NJ9NMRZBXT1H6FT9N7735

curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/user_rebates?expand=rebate_type' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

OK

Headers

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default 1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default 999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default 3600

Bodyapplication/jsonArray [

idstringread-only

urlstring(uri)read-only

statusanyread-only

Status of the user's rebate application form. This does not indicate if the rebate has been reviewed or approved.

Enum"NOT_STARTED""PENDING_TYPE_SELECTED""PENDING_IN_PROGRESS""COMPLETE"

rebate_typestring or RebateType (object)

One of:

string(uri)

]

Response

application/json

[
  {
    "$ref": "#/components/examples/UserRebate"
  }
]

Retrieve rebate application

Request

Retrieve a specific rebate application.

Security

oauth2

Path

user_rebate_idstringrbtu[A-Z\d]{26}required

Unique identifier for a User's rebate application

Example: rbtuB1USP6YGD1VPIDJSHTZARUX11M

Query

expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum"rebate_type""rebate_type.required_evidence"

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example: user01HN2NJ9NMRZBXT1H6FT9N7735

curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/user_rebates/rbtuB1USP6YGD1VPIDJSHTZARUX11M?expand=rebate_type' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

OK

Bodyapplication/json

idstringread-only

urlstring(uri)read-only

statusanyread-only

Status of the user's rebate application form. This does not indicate if the rebate has been reviewed or approved.

Enum"NOT_STARTED""PENDING_TYPE_SELECTED""PENDING_IN_PROGRESS""COMPLETE"

rebate_typestring or RebateType (object)

One of:

string(uri)

Response

application/json

{
  "$ref": "#/components/examples/UserRebate"
}

Update rebate application

Request

Attach evidence to a rebate application.

Security

oauth2

Path

user_rebate_idstringrbtu[A-Z\d]{26}required

Unique identifier for a User's rebate application

Example: rbtuB1USP6YGD1VPIDJSHTZARUX11M

Query

expandArray of strings

Specify a url field to expand into a nested resource.

Items Enum"rebate_type""rebate_type.required_evidence"

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example: user01HN2NJ9NMRZBXT1H6FT9N7735

Bodyapplication/json

rebate_typestringrequired

Rebate type resource uri

evidence_typestringrequired

Rebate evidence type resource uri

evidence_dataArray of objectsrequired

evidence_data[].idnumberrequired

Rebate evidence supporting data id

evidence_data[].valuestringrequired

Form field value. Should not include currency symbol.

curl -i -X PATCH \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/user_rebates/rbtuB1USP6YGD1VPIDJSHTZARUX11M?expand=rebate_type' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2' \
  -d '{
    "rebate_type": "https://api.ev.energy/v2/user_rebates/rbtuB1USP6YGD1VPIDJSHTZARUX11M",
    "evidence_type": "https://api.ev.energy/v2/user_rebates/rbetB1USP6YGD1VPIDJSHTZARUX11M",
    "evidence_data": [
      {
        "id": 2,
        "value": "1000"
      }
    ]
  }'

Responses

OK

Headers

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default 1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default 999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default 3600

Bodyapplication/json

idstring

uid of the user_rebate

urlstring

url of the user_rebate

Response

application/json

{
  "id": "string",
  "url": "string"
}

Submit a completed rebate form

Request

Once all evidence data and files have been uploaded, this endpoint is called to submit the rebate application for review by updating the Form status to "complete" and the application status to "pending_review".

Security

oauth2

Path

user_rebate_idstringrbtu[A-Z\d]{26}required

Unique identifier for a User's rebate application

Example: rbtuB1USP6YGD1VPIDJSHTZARUX11M

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example: user01HN2NJ9NMRZBXT1H6FT9N7735

curl -i -X POST \
  https://developers.ev.energy/_mock/ev.energy-api-v2/user_rebates/rbtuB1USP6YGD1VPIDJSHTZARUX11M:submit \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

OK

Headers

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default 1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default 999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default 3600

Response

No content

Start a file upload

Request

This endpoint creates the RebateEvidenceFile record and returns its uid as well as a presigned URL to use for direct upload to AWS S3.

Security

oauth2

Query

user_rebatestring

Application ID (uid) of the user_reabte

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example: user01HN2NJ9NMRZBXT1H6FT9N7735

Bodyapplication/json

Details of the file to be directly uploaded

file_namestring

Original file name of the incoming file, with extention.

rebate_evidence_typestring

Rebate evidence type url

curl -i -X POST \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/rebate_evidence_files:start_upload?user_rebate=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2' \
  -d '{
    "file_name": "string",
    "rebate_evidence_type": "string"
  }'

Responses

Created

Bodyapplication/json

idstring

evidence file uid

urlstring

evidence file resource url

presigned_urlstring

AWS S3 presigned URL. This URL is required for the client to send direct PUT or GET requests to S3

Response

application/json

{
  "id": "rbefB1USP6YGD1VPIDJSHTZARUX11M",
  "url": "https://api.ev.energy/v2/rebate_evidence_files/rbefB1USP6YGD1VPIDJSHTZARUX11M",
  "presigned_url": "https://cdn.app.ev.energy/evenergy-development-rebates-evidence-files/user_rebates/rbtuB1USP6YGD1VPIDJSHTZARUX11M/test_file-57e02f14d0c64900bfa5c64972799c51.pdf?AWSAccessKeyId=DummyKeyID&Signature=bmLFDDk%2FuEjCB8yqYI%2FojRTZEMc%3D&Expires=1732224896"
}

Finalize File Upload

Request

After the file is successfully uploaded to S3 via the presigned URL, this endpoint is called to set the upload_finished_at timestamp on the evidence_file record.

Security

oauth2

Path

rebate_evidence_file_idstringrbef[A-Z\d]{26}required

Unique identifier for a Rebate evidence file

Example: rbefB1USP6YGD1VPIDJSHTZARUX11M

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example: user01HN2NJ9NMRZBXT1H6FT9N7735

curl -i -X POST \
  https://developers.ev.energy/_mock/ev.energy-api-v2/rebate_evidence_files/rbefB1USP6YGD1VPIDJSHTZARUX11M:finish_upload \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

OK

Bodyapplication/json

idstring

Rebate evidence file uid

urlstring

Rebate evidence file resource url

Response

application/json

{
  "id": "rbefB1USP6YGD1VPIDJSHTZARUX11M",
  "url": "https://api.ev.energy/v2/rebate_evidence_files/rbefB1USP6YGD1VPIDJSHTZARUX11M"
}

List rebate evidence files

Request

List all user's rebate evidence files

Security

oauth2

Query

user_rebatestring

Application ID (uid) of the user_rebate

expandArray of strings

Specify a url field to expand into a nested resource.

Items Value"rebate_evidence_type"

Headers

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value2

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example: user01HN2NJ9NMRZBXT1H6FT9N7735

curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/rebate_evidence_files?user_rebate=string&expand=rebate_evidence_type' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

OK

Bodyapplication/jsonArray [

idstring

urlstring

file_namestring

rebate_evidence_typestring or RebateEvidenceType (object)

One of:

string(uri)

]

Response

application/json

No response example