Monitoring

Get Monitoring

Returns the monitoring of an identifier for your company, in any status (active, cancelled or expired).

get/monitoring/{identifier}

Request

Base URL
https://api.burodeingresos.com
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/burodeingresos/apis/bur-de-ingresos-api/docs/monitoring/:identifier/get.ts
A function with typed inputs. Its response is checked against the schema.

identifierstring required

Example:MAPE850312HDFRRR02

The identifier: 18-char CURP (individual) or 12-char RFC (business).

The monitoring.

idstring uuid

Unique identifier of the monitoring.

identifierstring

The monitored identifier.

status'active' | 'cancelled' | 'expired'

active: verified about once a month. cancelled: cancelled by your company. expired: its consent ran out.

enrolled_atstring date-time

When the identifier was enrolled.

expires_atstring date-time nullable

When the monitoring expires: its consent's expiry. Always present; null when the monitoring was enrolled with ip_address and does not expire.

cancelled_atstring date-time

When the monitoring was cancelled. Present only when it was cancelled.