Skip to main content
POST
File a flag

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Body

application/json
subject_type
enum<string>
required

Whether the flag is about a person or an animal.

Available options:
person,
animal
flag_type
enum<string>
required
Available options:
animal_abuse,
neglect,
fraud,
abandonment,
falsified_application,
other
severity
enum<string>
required
Available options:
advisory,
moderate,
severe
narrative
string
required

Why the flag was raised. Required, and shown in full to every organization that can see the flag.

Minimum string length: 1
identifiers
object
required

What the flag can be found by. At least one key. A person may carry name, name_alias, email, phone, phone_country, address, date_of_birth and microchip_number. An animal may carry microchip_number, animal_name, species, breed, color, sex and name_alias. Any other key is refused. After masking at least one searchable value must be left: a street address alone is refused.

visibility
enum<string>
default:network

network: other organizations can see it once it is active. private: only your organization ever sees it.

Available options:
network,
private
evidence_refs
any[]

References to your evidence, kept as you send them and shown to every organization that can see the flag.

Response

The flag, as it was filed, with its identifiers masked.

id
string
required
originating_tenant_id
string
required

The ID of the organization that filed it.

subject_type
enum<string>
required

Whether the flag is about a person or an animal.

Available options:
person,
animal
identifiers
object
required

The identifiers as a reader sees them. Only the keys the flag was filed with are present.

Nothing hashed comes back (Phase 422). A microchip number, an email address, a phone number, a date of birth and a street address are stored ONLY as hashes, and those hashes are not returned: a date of birth has about 36,500 plausible values, a phone number with its area code has ten million, and a hash handed to a reader is one offline pass away from being the value itself. What you get instead is the part that was always meant to be read - the birth YEAR, the town and state, the name, the animal’s description.

To match what you already hold, SEND IT: GET /api/registry/search takes microchip_number, email, phone, date_of_birth, address and name_alias as plain values, hashes them the same way the flag was hashed, and answers with the flags that match. That is the whole bargain this registry works to - confirm what you hold, and do not harvest what you do not.

flag_type
enum<string>
required
Available options:
animal_abuse,
neglect,
fraud,
abandonment,
falsified_application,
other
severity
enum<string>
required
Available options:
advisory,
moderate,
severe
status
enum<string>
required

pending_review until two other organizations corroborate it (then active), or two dispute it (then disputed). Nothing sets revoked at present.

Available options:
pending_review,
active,
disputed,
revoked
visibility
enum<string>
required

network: other organizations can see it once it is active. private: only your organization ever sees it.

Available options:
network,
private
narrative
string
required
evidence_refs
any[]
required
moderation_metadata
object
required

The tally of other organizations' reviews.

review_closes_on
string<date> | null
required

The day this flag's review closes: 14 days after it was filed, or after it was last asked again. Null for a private flag, which nobody is asked to review. Two corroborations or two disputes settle a flag before then; on this day the votes cast decide it.

review_outcome
enum<string> | null
required

Null while the review is open, and when the votes made the flag active. not_corroborated: the review closed with as many or more votes to dispute it or say there is not enough evidence as to corroborate it (a tie included). expired: it closed with no votes; the organization that filed it can ask again. Either way the flag stays pending_review, is not a finding, and is open to nobody's review.

Available options:
not_corroborated,
expired,
null
created_at
string<date-time>
required
updated_at
string<date-time>
required
rereview_closes_on
string<date> | null

Two disputes on an active flag put its finding back to a vote: the day that vote closes. Null when none opened.

rereview_outcome
enum<string> | null

How that vote closed: upheld (it stays active) or disputed. Null while it is open, or when none opened.

Available options:
upheld,
disputed,
null