Skip to content

A form's real-time address check and its 30-day numbers

GET
/api/v1/workspaces/{workspace}/verification/forms/{form}
curl --request GET \
--url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/verification/forms/example \
--header 'Authorization: Bearer <token>'

Permission: subscribers:view

workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

form
required

A form’s id, or subscribe_page

string
/^[a-z0-9_-]{1,64}$/

A form’s id, or subscribe_page

OK

Media typeapplication/json
object
askedToFix
required
integer format: int64
canChange
required
boolean
down
required
boolean
enabled
required
boolean
formKey
required
string
helpers
required
Array<string>
price
required
number format: double
service

The forms default service; empty when there is none

string
serviceName
string
waiting
required
integer format: int64

Example generated

{
"askedToFix": 1,
"canChange": true,
"down": true,
"enabled": true,
"formKey": "example",
"helpers": [
"example"
],
"price": 1,
"service": "example",
"serviceName": "example",
"waiting": 1
}

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example

{
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}