The person data of one member

GET /members/data/{memberCode}

The Studio calls it with the member code as the person typed it at onboarding without a challenge code and at every eligibility check, unless a filter needs claims (then it calls "The claims of one member"), and compares the first name, last name and birth date with what was entered. It also calls it with the stored member code for the member data a frontend reads (with a deadline of 1.5 seconds) and with the test member code in the connection test. Answer 404 for a member code the register does not hold.

Authentication

appsolut_m2m (sent in the header x-api-key): The "API key" entered in the register's connection in the Studio, sent with every call. The Studio keeps it encrypted and never shows it again. Answer 401 or 403 to a wrong key.

Parameters

Name	In	Required	Type	Description
`memberCode`	path	Yes	string	The member code, URL-encoded as one path segment. Example: `100001`.
`x-tenant-id`	header	Yes	string	The "Tenant ID" entered in the register's connection in the Studio, sent unchanged with every call. Your register can use it to tell apart the organisations it serves. Example: `pannoniqa`.
`x-custom-scope`	header	Yes	string	The "Scope" entered in the register's connection in the Studio, sent unchanged with every call. Your register can use it to choose the data set it answers from. Example: `employees`.

Responses

200

The member's status and person data. For the membership check, the first name, last name and birth date are required; without them the Studio treats the register as unavailable.

Content type: application/json

Field	Type	Required	Description
`source`	string	Yes	The name of your data source, such as "SAP HR".
`status`	object	Yes
`status.statusCode`	string	Yes	The member's status in the register. Filters in the membership definition and in communities can check it. Allowed values: `active`, `inactive`, `pending`.
`params`	object	Yes	The person data the register holds. Every field is optional in the contract, but where the Studio compares facts it needs the first name, last name and birth date. The address is member data a frontend may show its signed-in member.
`params.firstName`	string	No	First name.
`params.lastName`	string	No	Last name.
`params.memberCode`	string	No	The member code as the register holds it.
`params.birthDate`	string (date)	No	Birth date, YYYY-MM-DD.
`params.zip`	string	No	Postal code.
`params.city`	string	No	City.
`params.street`	string	No	Street and house number.
`params.country`	string	No	Country code, such as AT.

Example: An active employee

{
  "source": "SAP HR",
  "status": {
    "statusCode": "active"
  },
  "params": {
    "firstName": "Anna",
    "lastName": "Berger",
    "memberCode": "100001",
    "birthDate": "1979-02-02",
    "zip": "7100",
    "city": "Neusiedl am See",
    "street": "Musterweg 3",
    "country": "AT"
  }
}

Example: A retired employee

{
  "source": "SAP HR",
  "status": {
    "statusCode": "inactive"
  },
  "params": {
    "firstName": "Johann",
    "lastName": "Novak",
    "memberCode": "100009",
    "birthDate": "1952-07-07",
    "zip": "7000",
    "city": "Eisenstadt",
    "street": "Beispielgasse 7",
    "country": "AT"
  }
}

400

The register could not process the request. The Studio treats it as the register being unavailable and does not read the body.

Content type: text/plain

Type: string

Example

Bad request

401

The API key is wrong. The Studio reports the credentials as rejected (it does the same for 403) and treats the register as unavailable.

Content type: text/plain

Type: string

Example

Unauthorized

404

The register holds no member with this member code. The Studio treats the person as not found in this register.

Content type: text/plain

Type: string

Example

Not found

The person data of one member

GET /members/data/{memberCode}

Authentication

appsolut_m2m (sent in the header x-api-key): The "API key" entered in the register's connection in the Studio, sent with every call. The Studio keeps it encrypted and never shows it again. Answer 401 or 403 to a wrong key.

Parameters

Name	In	Required	Type	Description
`memberCode`	path	Yes	string	The member code, URL-encoded as one path segment. Example: `100001`.
`x-tenant-id`	header	Yes	string	The "Tenant ID" entered in the register's connection in the Studio, sent unchanged with every call. Your register can use it to tell apart the organisations it serves. Example: `pannoniqa`.
`x-custom-scope`	header	Yes	string	The "Scope" entered in the register's connection in the Studio, sent unchanged with every call. Your register can use it to choose the data set it answers from. Example: `employees`.

Responses

200

The member's status and person data. For the membership check, the first name, last name and birth date are required; without them the Studio treats the register as unavailable.

Content type: application/json

Field	Type	Required	Description
`source`	string	Yes	The name of your data source, such as "SAP HR".
`status`	object	Yes
`status.statusCode`	string	Yes	The member's status in the register. Filters in the membership definition and in communities can check it. Allowed values: `active`, `inactive`, `pending`.
`params`	object	Yes	The person data the register holds. Every field is optional in the contract, but where the Studio compares facts it needs the first name, last name and birth date. The address is member data a frontend may show its signed-in member.
`params.firstName`	string	No	First name.
`params.lastName`	string	No	Last name.
`params.memberCode`	string	No	The member code as the register holds it.
`params.birthDate`	string (date)	No	Birth date, YYYY-MM-DD.
`params.zip`	string	No	Postal code.
`params.city`	string	No	City.
`params.street`	string	No	Street and house number.
`params.country`	string	No	Country code, such as AT.

Example: An active employee

{
  "source": "SAP HR",
  "status": {
    "statusCode": "active"
  },
  "params": {
    "firstName": "Anna",
    "lastName": "Berger",
    "memberCode": "100001",
    "birthDate": "1979-02-02",
    "zip": "7100",
    "city": "Neusiedl am See",
    "street": "Musterweg 3",
    "country": "AT"
  }
}

Example: A retired employee

{
  "source": "SAP HR",
  "status": {
    "statusCode": "inactive"
  },
  "params": {
    "firstName": "Johann",
    "lastName": "Novak",
    "memberCode": "100009",
    "birthDate": "1952-07-07",
    "zip": "7000",
    "city": "Eisenstadt",
    "street": "Beispielgasse 7",
    "country": "AT"
  }
}

400

The register could not process the request. The Studio treats it as the register being unavailable and does not read the body.

Content type: text/plain

Type: string

Example

Bad request

401

The API key is wrong. The Studio reports the credentials as rejected (it does the same for 403) and treats the register as unavailable.

Content type: text/plain

Type: string

Example

Unauthorized

404

The register holds no member with this member code. The Studio treats the person as not found in this register.

Content type: text/plain

Type: string

Example

Not found