status > get

Get Brand Status

Retrieve a brand's status.

get/status/brand/{brandId}

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/status/brand/{brandId}
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

brandIdstring required

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.

errorsstring[] required

List of errors that occurred.

idstring required

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

status'PENDING' | 'UNVERIFIED' | 'VERIFIED' | 'VETTED' | 'FAILED' | 'INCOMPLETE' required

Current review status of the brand.

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

Changes

No recorded changes to this operation across all 1 revision of this API.