Child pages
  • SOR-Registry Strawman ID Match API

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This draft is based on the ID Match Strawman. All services are mandatory unless otherwise stated.

(warning) (warning) Identifiers used by the Match API may be returned in either string or number notation. This includes the match reference identifier, the match request identifier, and any local identifiers.

...

In this example, sis is the SOR label and 971194843 is the SOR ID for the candidate.

(warning) (warning) If the SOR ID is sensitive (such as being an SSN), placing it in the URL may not be ideal. In such a case, use of a salted-hashed identifier is recommended.

...

Code Block
GET /v1/people/sis/971194843

200 OK
{
  "sorAttributes":
  {
    "names":[
      {
        "type":"official",
        "given":"Patricia",
        "family":"Lee"
      }
    ],
    "dateOfBirth":"1983-03-18",
    "identifiers":[
      {
        "type":"national",
        "identifier":"3B902AE12DF55196"
      }
    ],
    "telephoneNumbers":[
      {
        "type":"mobile",
        "number":"8185551234"
      }
    ]
  },
  "requestTime":"2013-06-08T11:23:37Z",
  "resolutionTime":"2013-06-10T11:23:37Z",
  "referenceId":"M523441767"}

...