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. <br> `INCOMPLETE`: Has not been submitted. Use the [submit endpoint](../brands/submit). <br> `PENDING`: Currently being reviewed. <br> `VERIFIED`: Verified and good to go. <br> `UNVERIFIED`: No longer verified due to an update in the brand details. Requires vetting to be reverified. <br> `VETTED`: Brand has been vetted by an external provider and has received vetting scores. <br>

Errors