HTTP response codes
Check what each status code means and how returned values are formatted
Check the status code first. A 2xx means the call worked. Anything else means it didn't, and the body tells you why.
The Priority Commerce Engine (PCE) uses standard HTTP status codes on every onboarding call.
Status codes
| Code | What it means | What to do |
|---|---|---|
200 OK | A read or update worked. | Use the record in the body. |
201 Created | A record was created. | Store the id in the body. |
400 Bad Request | The body is empty or isn't valid JSON. | Fix the JSON and send again. |
401 Unauthorized | Your API key is missing or not valid. | Check the x-api-key header. |
403 Forbidden | Your key can't make this call. | Contact Priority support. |
404 Not Found | The ID in the path doesn't exist. | Check the ID you stored. |
409 Conflict | A value that must be unique already belongs to another record: an externalId you've already used, or an SSN or government ID already linked to another person. | Read errors to see which value clashed. For a shared SSN or government ID, link the person who already exists instead of adding them again. See API error handling. |
422 Unprocessable Content | A value is missing, badly formatted or breaks a rule. | Fix the fields listed in errors. See API error handling. |
429 Too Many Requests | You sent too many requests. | Wait and retry with backoff. |
500, 503 | Something went wrong on PCE's side. | Retry with backoff. |
A single record comes back as a JSON object. A list comes back with the records in data. See Pagination.
Value formats
| Value | Format |
|---|---|
| Percentages and counts | JSON numbers, for example "ownershipPercentage": 50.00. |
| Money amounts | JSON numbers in US dollars, for example estimatedMonthlyVolume and avgTicket. |
| Phone numbers | E.164 where required, for example "+15555550100". |
| Timestamps | ISO 8601 in UTC, for example createdAt. |
| Tax IDs, account numbers, ID numbers | Only the last four digits come back. See Data handling and compliance. |
Next steps
Updated 9 days ago
Did this page help you?