omnistate/matchid API reference

Omnistate\MatchId

MatchId class

final class MatchId implements CivilRegistryInterface MatchId.php:32

France's deaths since 1970: INSEE's file of deceased persons, searched through matchID (deces.matchid.io, run by the French Ministry of the Interior). One record per death: the names, the sex, the date and place of birth, the date and place of death, the act's number. No picture of the act: the file is an index, the act itself is at the town hall.

Free, no key. A token (an account at deces.matchid.io) raises the quota; it is sent as "Authorization: Bearer".

const URL = 'https://deces.matchid.io/deces/api/v1'

const PAGE = 'https://deces.matchid.io/id/'

A record's page on matchID's own site.

MatchId::__construct()

public function __construct(readonly HttpClientInterface $http, readonly ?string $token = null, readonly float $timeout = 10, readonly string $url = self::URL)

MatchId::name()

public function name(): string

MatchId::countries()

public function countries(): array

MatchId::kinds()

public function kinds(): array

MatchId::period()

public function period(): ?Period

MatchId::hasImages()

public function hasImages(): bool

MatchId::supports()

public function supports(CivilQuery $query): bool

A name at least: the file is not browsed by date alone here. Deaths before 1970 are not in it.

MatchId::search()

public function search(CivilQuery $query): array

MatchId::find()

public function find(string $identifier): ?CivilRecord