Error examples

The error examples listed below relate to customer information and the 400 error code.

Required parameter is missing

The following parameters are required but are missing from the POST request payload:

• dob
• first_name
• last_name

The response payload is shown below.

{
    "dob": [
        "Missing data for required field."
    ],
    "names": {
            "first_name": [
                "Missing data for required field."
            ],
            "last_name": [
                "Missing data for required field."
            ]
      }
}

The following parameters are required but are missing from the DELETE related request payload:

• p_id
• target_type
• target_id

The response payload is shown below.

{
    "Error": "Person id, target type, and target id are required."
}

Incorrect format

The date_added parameter is not in the correct format. For example, 10-31-1999 is meant to be Oct. 31, 1999, but it should be submitted as 31-10-1999.

The response payload is shown below.

{
    "names": {
                "date_added": [
                "Not a valid date."
            ]
     }
}

Rule is violated

Only one legal name is allowed, such as:

• More than one legal name via POST
• Trying to add an additional legal name via PATCH
• Trying to remove a legal name via PATCH or DELETE

The response payload is shown below.

{
    "names": {
            "is_legal_name": [
                "One legal name is required"
            ]
     }
}

Invalid person ID in a GET

The person's ID is invalid.

The response payload is shown below.

{
    "message": "The requested URL was not found on the server. If you entered the URL manually. Please check your spelling and try again."
}