Documentation

Mistake on this page? Email us

Enrollment API

Connect Enrollment Service allows users to claim ownership of a device not yet associated with an account. A device without an assigned account could be one purchased from the open market (OEM dealer) or transferred from one account to another. Refer to the documentation on Device ownership: First-to-claim.
Version: 3
Host: http://api.us-east-1.mbedcloud.com

Endpoints

PublicAPI

post /v3/device-enrollments-bulk-uploads

With bulk upload, you can upload a CSV file containing a number of enrollment IDs.

Example:

curl -X POST \
-H 'Authorization: Bearer <api_key>' \
-F 'enrollment_identities=@/path/to/enrollments/enrollments.csv' \
https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-uploads

To ensure your CSV file is valid:

  1. The first line of the file (header) is ignored.
  2. Each line can contain comma-separated values, where the first value is the Enrollment ID. Everything after the first comma is ignored.
  3. Valid enrollments begin with A followed by a - and 95 characters (examples below).
  4. One enrollment ID per line. Empty lines are ignored.
  5. Trailing comma at the end of the line is optional.
  6. Lines are terminated with either a line feed \n, a carriage return \r, or both \r\n.
  7. Leading and trailing whitespace characters (Unicode U+0000 - U+0020) are removed from the identity before validation.
  8. Empty identities are ignored.
  9. Valid enrollment identities may be enclosed within quotation marks. Whitespace inside quotation marks is not trimmed and will cause validation to fail. Empty quotation marks are also invalid.
  10. Use UTF-8 encoding.

A valid enrollment file:

"Examples of valid identites, notes"
"A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:44:71:93:23:22:15:43:23:12",
"A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:25:48:44:71:22:15:43:23:12"
A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:25:48:44:71:22:15:43:23:12
A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:25:24:44:71:22:15:43:23:12, This text is ignored.
 A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:60:25:48:44:71:22:15:43:23:12       , Whitespace is trimmed before validation.
  "A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:60:25:48:44:71:22:15:43:23:12"       , Whitespace around quotation marks is also trimmed.

A file containing invalid identities:

"A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:44:71:93:23:22:15:43:23:12", First line is ignored.
A_4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:25:48:44:71:22:15:43:23:12, Invalid version identifier.
A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:25:48:44:71:22:15:43:23:12, Too-short identity.
"", Empty quotation marks are an invalid identity
" A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:44:71:93:23:22:15:43:23:12 ", Whitespace inside quotation marks is not trimmed, causing an error.

An empty file:

"Examples of blank lines that are ignored"

,,
, This is also considered a blank line.
Consumes
This API call consumes the following media types via the Content-Type request header:
  • multipart/form-data
Form parameters
enrollment_identities (required)
Form Parameter — The CSV file containing the enrollment IDs. The maximum file size is 10 MB.
Return type
Example data
Content-Type: application/json
{
  "completed_at" : "2000-01-23T04:56:07.000+00:00",
  "account_id" : "00005a4e027f0a580a01081c00000000",
  "total_count" : 10,
  "full_report_file" : "https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-uploads/2d238a89038b4ddb84699dd36a901063/full_report.csv",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "etag" : "1",
  "processed_count" : 0,
  "id" : "aeiou",
  "errors_report_file" : "https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-uploads/2d238a89038b4ddb84699dd36a901063/errors_report.csv",
  "object" : "enrollment-identity-bulk-uploads",
  "status" : "new",
  "errors_count" : 0
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
201 Bulk upload data received and asynchronous processing started. BulkResponse
400 Bad request. ErrorResponse
401 Invalid access token. ErrorResponse
post /v3/device-enrollments
Create a single enrollment. Show more Show less

When the device connects to the bootstrap server and provides the enrollment ID, it is assigned to your account.
Example:

curl -X POST \
-H 'Authorization: Bearer <api_key>' \
-H 'content-type: application/json' \
https://api.us-east-1.mbedcloud.com/v3/device-enrollments \
-d '{"enrollment_identity": "A-35:e7:72:8a:07:50:3b:3d:75:96:57:52:72:41:0d:78:cc:c6:e5:53:48:c6:65:58:5b:fa:af:4d:2d:73:95:c5"}'
Consumes
This API call consumes the following media types via the Content-Type request header:
  • application/json
Request body
enrollment_identity EnrollmentId (required)
Body Parameter
Return type
Example data
Content-Type: application/json
{
  "enrolled_device_id" : "00005a4e027f0a580a01081c00000000",
  "claimed_at" : "2000-01-23T04:56:07.000+00:00",
  "account_id" : "00005a4e027f0a580a01081c00000000",
  "expires_at" : "2000-01-23T04:56:07.000+00:00",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "etag" : "7642xfaxz",
  "id" : "00005a4e027f0a580a01081c00000000",
  "enrollment_identity" : "A-35:e7:72:8a:07:50:3b:3d:75:96:57:52:72:41:0d:78:cc:c6:e5:53:48:c6:65:58:5b:fa:af:4d:2d:73:95:c5",
  "object" : "enrollment"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
201 Created. The enrollment claim has been created and is waiting for the device to connect. EnrollmentIdentity
400 Bad request. The enrollment identity is not valid. ErrorResponse
401 The provided access token is not valid. ErrorResponse
409 Conflict. The requested identity to add already exists on this or another account. ErrorResponse
post /v3/device-enrollments-bulk-deletes

With bulk delete, you can upload a CSV file containing a number of enrollment IDs to delete.

Example:

curl -X POST \
-H 'Authorization: Bearer <api_key>' \
-F 'enrollment_identities=@/path/to/enrollments/enrollments.csv' \
https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-deletes

To ensure your CSV file is valid:

  1. The first line of the file (header) is ignored.
  2. Each line can contain comma-separated values, where the first value is the Enrollment ID. Everything after the first comma is ignored.
  3. Valid enrollments begin with A followed by a - and 95 characters (examples below).
  4. One enrollment ID per line. Empty lines are ignored.
  5. Trailing comma at the end of the line is optional.
  6. Lines are terminated with either a line feed \n, a carriage return \r, or both \r\n.
  7. Leading and trailing whitespace characters (Unicode U+0000 - U+0020) are removed from the identity before validation.
  8. Empty identities are ignored.
  9. Valid enrollment identities may be enclosed within quotation marks. Whitespace inside quotation marks is not trimmed and will cause validation to fail. Empty quotation marks are also invalid.
  10. Use UTF-8 encoding.

A valid enrollment file:

"Examples of valid identites, notes"
"A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:44:71:93:23:22:15:43:23:12",
"A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:25:48:44:71:22:15:43:23:12"
A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:25:48:44:71:22:15:43:23:12
A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:25:24:44:71:22:15:43:23:12, This text is ignored,
 A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:60:25:48:44:71:22:15:43:23:12       , Whitespace is trimmed before validation.
  "A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:60:25:48:44:71:22:15:43:23:12"       , Whitespace around quotation marks is also trimmed.

A file containing invalid identities:

"A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:44:71:93:23:22:15:43:23:12", First line is ignored.
A_4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:25:48:44:71:22:15:43:23:12, Invalid version identifier.
A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:25:48:44:71:22:15:43:23:12, Too-short identity.
"", Empty quotation marks are an invalid identity.
" A-4E:63:2D:AE:14:BC:D1:09:77:21:95:44:ED:34:06:57:1E:03:B1:EF:0E:F2:59:44:71:93:23:22:15:43:23:12 ", Whitespace inside quotation marks is not trimmed, causing an error.

An empty file:

"Examples of blank lines that are ignored."

,,
, This is also considered to a blank line.
Consumes
This API call consumes the following media types via the Content-Type request header:
  • multipart/form-data
Form parameters
enrollment_identities (required)
Form Parameter — The CSV file containing the enrollment IDs. The maximum file size is 10MB.
Return type
Example data
Content-Type: application/json
{
  "completed_at" : "2000-01-23T04:56:07.000+00:00",
  "account_id" : "00005a4e027f0a580a01081c00000000",
  "total_count" : 10,
  "full_report_file" : "https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-uploads/2d238a89038b4ddb84699dd36a901063/full_report.csv",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "etag" : "1",
  "processed_count" : 0,
  "id" : "aeiou",
  "errors_report_file" : "https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-uploads/2d238a89038b4ddb84699dd36a901063/errors_report.csv",
  "object" : "enrollment-identity-bulk-uploads",
  "status" : "new",
  "errors_count" : 0
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
201 Bulk delete data received and asynchronous processing started. BulkResponse
400 Bad request. ErrorResponse
401 Invalid access token. ErrorResponse
delete /v3/device-enrollments/{id}
Delete an enrollment by ID. Show more Show less

To free a device from your account, delete the enrollment claim. To bypass the device ownership, you need to delete the enrollment and factory reset the device. For more information, see Transferring ownership using First-to-Claim.
Example:

curl -X DELETE \
-H 'Authorization: Bearer <api_key>' \
https://api.us-east-1.mbedcloud.com/v3/device-enrollments/{id}
Path parameters
id (required)
Path Parameter — Enrollment identity.
Consumes
This API call consumes the following media types via the Content-Type request header:
  • application/json
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
204 No content. The enrollment claim has been deleted.
400 Bad request. Invalid enrollment identity. ErrorResponse
404 Not found. ErrorResponse
get /v3/device-enrollments-bulk-uploads/{id}
Get bulk upload entity. Show more Show less

Provides information on bulk upload for the given ID, for example, bulk status and number of processed enrollment identities. Provides links to bulk upload reports as well.

Report file format: The report files have a header line, and the values are separated by commas. Delimit lines with a line break (CRLF). Make sure the report file is compliant with IETF Informal CSV common format RFC 4180.

An example of a full report file:

"entity__id","entity__created_at","error__code","error__type","error__message","error__fields"
"A-F9:AA:AA:AA:DE:31:C7:30:72:55:27:AE:8B:E1:1C:6F:42:7D:06:CF:FB:18:6F:59:48:29:B3:98:4B:76:8F:9E","2018-09-07T12:10:58.428Z","","","",""
"A-FF:AA:AA:AA:3B:43:EB:D7:C7:30:03:5F:C8:D0:15:91:70:C2:5D:4F:EB:24:E9:3A:BB:D8:3C:FE:20:EA:B1:72","2018-09-07T12:10:58.428Z","","","",""

An example of an error report file:

"entity__id","error__code","error__type","error__message","error__fields"
"A-F9:AA:AA:AA:DE:31:C7:30:72:55:27:AE:8B:E1:1C:6F:42:7D:06:CF:FB:18:6F:59:48:29:B3:98:4B:76:8F:9E","409","duplicate","Enrollment identity is already claimed in the mbed Cloud.",""
"A-FF:AA:AA:AA:3B:43:EB:D7:C7:30:03:5F:C8:D0:15:91:70:C2:5D:4F:EB:24:E9:3A:BB:D8:3C:FE:20:EA:B1:72","409","duplicate","Enrollment identity is already claimed in the mbed Cloud.",""

Example:

curl -X GET \
-H 'Authorization: Bearer <api_key>' \
https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-uploads/{id}
Path parameters
id (required)
Path Parameter — Bulk create task entity ID.
Consumes
This API call consumes the following media types via the Content-Type request header:
  • application/json
Return type
Example data
Content-Type: application/json
{
  "completed_at" : "2000-01-23T04:56:07.000+00:00",
  "account_id" : "00005a4e027f0a580a01081c00000000",
  "total_count" : 10,
  "full_report_file" : "https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-uploads/2d238a89038b4ddb84699dd36a901063/full_report.csv",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "etag" : "1",
  "processed_count" : 0,
  "id" : "aeiou",
  "errors_report_file" : "https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-uploads/2d238a89038b4ddb84699dd36a901063/errors_report.csv",
  "object" : "enrollment-identity-bulk-uploads",
  "status" : "new",
  "errors_count" : 0
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/csv
  • application/json
Responses
status description schema
200 Bulk upload entity found. BulkResponse
400 Bad request. Invalid bulk identity. ErrorResponse
401 Invalid access token. ErrorResponse
404 Not found. ErrorResponse
get /v3/device-enrollments-bulk-deletes/{id}
Get bulk delete entity. Show more Show less

Provides information on bulk delete for the given ID, for example, bulk status and the number of processed enrollment identities. Provides links to bulk delete reports as well.

Report file format: The report files have a header line and the value are separated by commas. The lines are delimited by a line break (CRLF). Make sure the report file is compliant with IETF Informal CSV common format RFC 4180.

An example of a full report file:

"entity__id","entity__deleted_at","error__code","error__type","error__message","error__fields"
"A-F9:AA:AA:AA:DE:31:C7:30:72:55:27:AE:8B:E1:1C:6F:42:7D:06:CF:FB:18:6F:59:48:29:B3:98:4B:76:8F:9E","2018-09-07T12:10:58.428Z","","","",""
"A-FF:AA:AA:AA:3B:43:EB:D7:C7:30:03:5F:C8:D0:15:91:70:C2:5D:4F:EB:24:E9:3A:BB:D8:3C:FE:20:EA:B1:72","2018-09-07T12:10:58.428Z","","","",""

An example of an error report file:

"entity__id","error__code","error__type","error__message","error__fields"
"A-F9:AA:AA:AA:DE:31:C7:30:72:55:27:AE:8B:E1:1C:6F:42:7D:06:CF:FB:18:6F:59:48:29:B3:98:4B:76:8F:9E","409","duplicate","Enrollment identity is already claimed in the mbed Cloud.",""
"A-FF:AA:AA:AA:3B:43:EB:D7:C7:30:03:5F:C8:D0:15:91:70:C2:5D:4F:EB:24:E9:3A:BB:D8:3C:FE:20:EA:B1:72","409","duplicate","Enrollment identity is already claimed in the mbed Cloud.",""

Example:

curl -X GET \
-H 'Authorization: Bearer <api_key>' \
https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-deletes/{id}
Path parameters
id (required)
Path Parameter — Bulk delete task entity ID.
Consumes
This API call consumes the following media types via the Content-Type request header:
  • application/json
Return type
Example data
Content-Type: application/json
{
  "completed_at" : "2000-01-23T04:56:07.000+00:00",
  "account_id" : "00005a4e027f0a580a01081c00000000",
  "total_count" : 10,
  "full_report_file" : "https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-uploads/2d238a89038b4ddb84699dd36a901063/full_report.csv",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "etag" : "1",
  "processed_count" : 0,
  "id" : "aeiou",
  "errors_report_file" : "https://api.us-east-1.mbedcloud.com/v3/device-enrollments-bulk-uploads/2d238a89038b4ddb84699dd36a901063/errors_report.csv",
  "object" : "enrollment-identity-bulk-uploads",
  "status" : "new",
  "errors_count" : 0
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • text/csv
  • application/json
Responses
status description schema
200 Bulk delete entity found. BulkResponse
400 Bad request. Invalid bulk identity. ErrorResponse
401 Invalid access token. ErrorResponse
404 Not found. ErrorResponse
get /v3/device-enrollments/{id}
Get details of an single enrollment by ID. Show more Show less

Check detailed enrollment info, for example, date of claim or expiration date.

Example:

curl -X GET \
-H 'Authorization: Bearer <api_key>' \
https://api.us-east-1.mbedcloud.com/v3/device-enrollments/{id}
Path parameters
id (required)
Path Parameter — Enrollment identity.
Consumes
This API call consumes the following media types via the Content-Type request header:
  • application/json
Return type
Example data
Content-Type: application/json
{
  "enrolled_device_id" : "00005a4e027f0a580a01081c00000000",
  "claimed_at" : "2000-01-23T04:56:07.000+00:00",
  "account_id" : "00005a4e027f0a580a01081c00000000",
  "expires_at" : "2000-01-23T04:56:07.000+00:00",
  "created_at" : "2000-01-23T04:56:07.000+00:00",
  "etag" : "7642xfaxz",
  "id" : "00005a4e027f0a580a01081c00000000",
  "enrollment_identity" : "A-35:e7:72:8a:07:50:3b:3d:75:96:57:52:72:41:0d:78:cc:c6:e5:53:48:c6:65:58:5b:fa:af:4d:2d:73:95:c5",
  "object" : "enrollment"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 OK. Pending enrollment data. EnrollmentIdentity
400 Bad request. Invalid enrollment identity. ErrorResponse
404 Not found. ErrorResponse
get /v3/device-enrollments
Get a list of enrollments per account. Show more Show less

Provides a list of pending and claimed enrollments.

Example:

curl -X GET \
-H 'Authorization: Bearer <api_key>' \
https://api.us-east-1.mbedcloud.com/v3/device-enrollments

With query parameters:

curl -X GET \
-H 'Authorization: Bearer <api_key>' \
'https://api.us-east-1.mbedcloud.com/v3/device-enrollments?limit=10'
Consumes
This API call consumes the following media types via the Content-Type request header:
  • application/json
Query parameters
limit (optional)
Query Parameter — Number of results to return (2-1000).
after (optional)
Query Parameter — Entity ID to fetch after.
order (optional)
Query Parameter — ASC or DESC default: ASC
include (optional)
Query Parameter — Comma-separated additional data to return. Currently supported: total_count.
Return type
Example data
Content-Type: application/json
{
  "data" : [ {
    "enrolled_device_id" : "00005a4e027f0a580a01081c00000000",
    "claimed_at" : "2000-01-23T04:56:07.000+00:00",
    "account_id" : "00005a4e027f0a580a01081c00000000",
    "expires_at" : "2000-01-23T04:56:07.000+00:00",
    "created_at" : "2000-01-23T04:56:07.000+00:00",
    "etag" : "7642xfaxz",
    "id" : "00005a4e027f0a580a01081c00000000",
    "enrollment_identity" : "A-35:e7:72:8a:07:50:3b:3d:75:96:57:52:72:41:0d:78:cc:c6:e5:53:48:c6:65:58:5b:fa:af:4d:2d:73:95:c5",
    "object" : "enrollment"
  } ],
  "total_count" : 100,
  "limit" : 50,
  "after" : "00005a4e027f0a580a01081c00000000",
  "has_more" : true,
  "object" : "list",
  "order" : "ASC"
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
  • application/json
Responses
status description schema
200 OK. EnrollmentIdentities
400 Bad request. The access token could not be read. ErrorResponse
401 The provided access token is not valid. ErrorResponse

Models

BulkResponse

object
Enum:
enrollment-identity-bulk-uploads
id
String Bulk ID
account_id
String ID
etag
String etag
created_at
Date The time of receiving the bulk creation task. format: date-time
status
String The state of the process is 'new' at the time of creation. If creation is still in progress, the state shows as 'processing'. When the request is fully processed, the state changes to 'completed'.
Enum:
new
processing
completed
total_count
Integer Total number of enrollment identities found in the input CSV.
processed_count
Integer The number of enrollment identities processed until now.
errors_count
Integer The number of enrollment identities with failed processing.
completed_at (optional)
Date The time the bulk creation task was completed. Null when creating bulk upload or delete. format: date-time
full_report_file
String Link to full report file. Null when creating bulk upload or delete.
errors_report_file
String Link to error report file. Null when creating bulk upload or delete.

EnrollmentId

enrollment_identity
String Enrollment identity.

EnrollmentIdentities

object
Enum:
list
limit
Integer Range 2-1000, or default.
after
String ID
order
Enum:
ASC
DESC
has_more
total_count
Integer format: int32
data

EnrollmentIdentity

object
Enum:
enrollment
id
String Enrollment identity.
etag
created_at
Date The time of the enrollment identity creation. format: date-time
claimed_at
Date The time the device was claimed. format: date-time
enrollment_identity
String Enrollment identity.
account_id
String ID
expires_at
Date The enrollment claim expiration time. If the device does not connect to Device Management before expiration, the claim is removed without separate notice. format: date-time
enrolled_device_id
String The ID of the device in the Device Directory once it is registered.

ErrorResponse

This object represents an error message.
object
String Entity name, always 'error'.
Enum:
error
code
Integer Response code. format: int32
type
String Error type.
Enum:
validation_error
invalid_token
invalid_apikey
reauth_required
access_denied
account_limit_exceeded
not_found
method_not_supported
not_acceptable
duplicate
precondition_failed
unsupported_media_type
rate_limit_exceeded
internal_server_error
system_unavailable
message
String A human readable message with detailed info.
request_id
String Request ID.
fields (optional)
array[Field] Failed input fields during request object validation.

Field

name (optional)
String The name of the erroneous field.
message (optional)
String A message describing the error situation.