BUburodeingresos
Monitoring

Enroll Monitoring

Changed on

Enrolls an identifier in monitoring for your company. Requires a valid consent for the identifier, unless you send ip_address: then a consent is recorded with that IP and your company's privacy notice, and the monitoring does not expire (expires_at is null). Otherwise expires_at is the consent's expiry.

If your company has no verification of the identifier in the last 30 days, the first verification runs right away; otherwise it runs 30 days after the last one. After that, the identifier is verified again about once a month while the monitoring is active.

Idempotent: enrolling an identifier that is already active keeps its enrollment date and only extends its expiry with a newer consent. A cancelled or expired monitoring becomes active again.

post/monitoring/{identifier}

Request

Path parameters

identifierstring required
Example:MAPE850312HDFRRR02

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

Request body

ip_addressstring

Optional. IPv4 or IPv6 address from which the individual gave consent. When sent, a consent is recorded with your company's privacy notice and the monitoring does not expire.

Example request

{
  "ip_address": "192.168.1.100"
}

Response

The monitoring, as it stands after the enrollment.

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.

Changes