VTEX · Example Payload

Vtex Post Apivtexidcredentialvalidate Example

CommerceE-CommerceRetailMarketplacePayments

Vtex Post Apivtexidcredentialvalidate Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "post-apivtexidcredentialvalidate",
  "method": "POST",
  "path": "/api/vtexid/credential/validate",
  "summary": "VTex Check authenticated user",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "authStatus": "Success",
        "id": "1f6c17e5-06f9-44a9-a459-b3686e03fa9d",
        "user": "john@mail.com",
        "account": "apiexamples",
        "audience": "admin",
        "tokenType": "user"
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "example": {
        "authStatus": "WrongCredentials"
      }
    }
  ]
}