/miit_icp/violations

POST /api/miit_icp/violations

Price: 5 credits

Check a domain, app, mini-program or quick app against China's MIIT blacklist of violating internet services: whether it is blacklisted, under restricted access or not listed, with the listing record when there is one.

How to use it

Always one row: status not_listed when the register holds no record for the name. For who filed a domain or app use miit_icp/filings/search.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Domain, or app name for the other types (examples: "baidu.com", "微信"; minLength: 1)
• service_type string — Kind of service to check (default: "website"; one of: "website", "app", "mini_program", "quick_app")

Response

• @type string (default: "MiitIcpViolation")
• query string required
• service_type string required (one of: "website", "app", "mini_program", "quick_app")
• status string nullable (one of: "blacklisted", "restricted", "not_listed")
• status_code string nullable
• domain string nullable
• name string nullable
• record_id string nullable
• access_licence string nullable
• cancelled_licence string nullable
• reason string nullable
• company_name string nullable
• company_certificate_number string nullable
• service_record_number string nullable
• remark string nullable
• listed_at integer nullable
• created_at integer nullable
• updated_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.