Skip to content

Retorna uma conta criada pelo parceiro

Request

Retorna uma conta vinculada ao parceiro identificado pelo token da requisição, com os mesmos campos da listagem de contas e o campo api_token. A conta pode ser identificada pelo seu identificador único (campo _id) ou pelo documento do empregador: CNPJ (incluindo o novo formato alfanumérico) ou CPF, sem pontuação.

O token de acesso da conta à API pública TiqueTaque (api_token) é retornado somente quando o header X-Secret da requisição corresponde à chave secreta da conta; caso contrário o campo não é retornado. A chave secreta é exibida somente no momento da criação de cada conta.

Security
BearerAuth
Path
account_idstring^([0-9a-fA-F]{24}|[0-9A-Za-z]{12}[0-9]{2}|[0-...required

Identificador único da conta (campo _id, 24 caracteres hexadecimais), CNPJ do empregador da conta (14 caracteres sem pontuação: 12 letras ou dígitos mais 2 dígitos verificadores, aceitando o novo formato alfanumérico, com letras maiúsculas ou minúsculas) ou CPF do empregador da conta (11 dígitos, sem pontuação).

Os documentos são procurados somente entre os empregadores das contas do parceiro e seus dígitos verificadores não são validados: um CNPJ ou CPF com formato válido que não corresponda a nenhuma conta do parceiro retorna 404. Documentos com pontuação ou qualquer outro formato retornam 422.

Examples:
Identificador único da conta
5f5bc225b511a6edec2891f7
CNPJ do empregador
23467093000164
CNPJ alfanumérico do empregador
12ABC34501DE35
CPF do empregador
01234567890
Headers
X-Secretstring

Chave secreta da conta (campo secret retornado na criação da conta). Quando presente e correspondente à chave secreta da conta, o campo api_token é retornado com o token de acesso à API pública.

curl -i -X GET \
  https://partner-api-docs.tiquetaque.com/_mock/openapi/partner-accounts/5f5bc225b511a6edec2891f7 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Secret: string'

Responses

Conta do parceiro.

Bodyapplication/json
_idstring

Identificador único da conta, gerado internamente.

Example:"5f5bc225b511a6edec2891f7"
_createdstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}[+-][0-2]...
Example:"2026-01-01T00:00:00+00:00"
namestring or null

Nome do empregador vinculado à conta.

Example:"TIQUETAQUE SERVICOS DE TECNOLOGIA S.A."
financial_emailstring or null

E-mail do setor financeiro do empregador vinculado à conta.

Example:"financeiro@empresa.com"
cnpjstring or null

CNPJ do empregador vinculado à conta. Apenas números.

Example:"23467093000164"
active_employeesinteger

Número de funcionários ativos da conta.

Example:12
subscription_employeesinteger

Número de funcionários contratados nas assinaturas da conta.

Example:15
subscription_face_idsinteger

Número de reconhecimentos faciais contratados na assinatura ativa da conta.

Example:5
api_tokenstring or null

Token de acesso da conta à API pública TiqueTaque (usado com autenticação BasicAuth sendo user=public, senha=&ltapi_token&gt). Presente somente quando o header X-Secret da requisição corresponde à chave secreta da conta (campo secret retornado na criação da conta); caso o header esteja ausente ou não corresponda, o campo não é retornado. Retorna null caso o token tenha sido revogado.

Example:"8f14e45fceea167a5a36dedd4bea2543"
Response
{
  "_id": "5f5bc225b511a6edec2891f7",
  "_created": "2026-01-01T00:00:00+00:00",
  "name": "TIQUETAQUE SERVICOS DE TECNOLOGIA S.A.",
  "financial_email": "financeiro@empresa.com",
  "cnpj": "23467093000164",
  "active_employees": 12,
  "subscription_employees": 15,
  "subscription_face_ids": 5,
  "api_token": "8f14e45fceea167a5a36dedd4bea2543"
}