Monitoramento

Cria uma nova assinatura de monitoramento para o alerta de multas

post/partner-monitoring/debt-alert/subscriptions

Request

Base URL
https://api.b2b.usezapay.com.br/v2
Auth
HTTP basic
TypeScript
https://skmtc.dev/usezapay/apis/zapi/docs/partner-monitoring/debt-alert/subscriptions/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

external_idstring required

Identificador externo da assinatura

plan_idstring uuid required

Identificador do plano

license_platestring required

Placa de identificação do veículo

state'AC' | 'AL' | 'AP' | 'AM' | 'BA' | 'CE' | 'DF' | 'ES' | 'GO' | 'MA' | 'MT' | 'MS' | 'MG' | 'PA' | 'PB' | 'PR' | 'PE' | 'PI' | 'RJ' | 'RN' | 'RS' | 'RO' | 'RR' | 'SC' | 'SP' | 'SE' | 'TO'

owner_documentstring nullable

Documento do proprietario do veiculo

renavamstring nullable

Renavam do veiculo

chassisstring nullable

Número do chassi do veículo sem pontuação

Example request

{
  "external_id": "123456",
  "plan_id": "ace81c40-c90d-42b7-947b-e63d44cb9262",
  "license_plate": "AAA1234"
}

Response

Successful Response

idstring uuid required

Identificador da assinatura

external_idstring nullable

Identificador externo

created_atstring date-time required

Data de criação

next_search_atstring date nullable

Data da próxima busca