API ReferenceStatus

Get Brand Status

Retrieve a brand's status.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

brandIdstringRequired

The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

Response

Successfully retrieved.
errorslist of strings
List of errors that occurred.
idstring

The unique identifier of the brand. This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

statusenum

Current review status of the brand.

INCOMPLETE: Has not been submitted. Use the submit endpoint.
PENDING: Currently being reviewed.
VERIFIED: Verified and good to go.
UNVERIFIED: No longer verified due to an update in the brand details. Requires vetting to be reverified.
VETTED: Brand has been vetted by an external provider and has received vetting scores.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
501
Not Implemented Error