Details of the user

GET /users/{UserEmailOrID}

oAuth

Headers

x-fapi-auth-date string

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

Format should match the following pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$.
x-fapi-customer-ip-address string

The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id string

An RFC4122 UID used as a correlation id.
x-customer-user-agent string

Indicates the user-agent that the PSU is using.

Path parameters

UserEmailOrID string Required

UUID or email address of the user. Note use of the email address is considered deprecated

Maximum length is 50. Format should match the following pattern: ^[^<>]*$.

Responses

200 application/json

Details of the user
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
Hide response attributes Show response attributes object
- BasicInformation object
  
  Additional properties are allowed.
  
  Hide BasicInformation attributes Show BasicInformation attributes object
  
  Status string
  
  Current status of this resource
  
  Values are Active or Inactive. Default value is Active.
  
  UserEmail string
  
  Format should match the following pattern: ^[^<>]*$.
  
  UserID string(uuid)
  
  The unique ID of a user
  
  Maximum length is 40.
- CertificationManager boolean
  
  Is the user a certification manager
- CreatedAt string(date-time)
- DataAdministrator boolean
  
  Is the user a data administrator
- DirectoryTermsAndConditionsDetails object
  
  Details of TnC
  
  Additional properties are allowed.
  
  Hide DirectoryTermsAndConditionsDetails attributes Show DirectoryTermsAndConditionsDetails attributes object
  
  RequiresSigning boolean
  
  Does the Directory TnC require signing
  
  TermsAndConditionsItem object
  
  Additional properties are allowed.
  
  Hide TermsAndConditionsItem attributes Show TermsAndConditionsItem attributes object
  
  Content string Required
  
  The MarkDown of the TnC
  
  Minimum length is 1. Format should match the following pattern: ^[^<>]*$.
  
  Name string Required
  
  The Name of the TnC
  
  Minimum length is 1. Format should match the following pattern: ^[^<>]*$.
  
  Status string
  
  Current status of this resource
  
  Values are Active or Inactive. Default value is Active.
  
  TnCId integer
  
  Unique identifier for the Terms and Conditions Item
  
  Type string Required
  
  Role for which this TnC applies
  
  Values are Participant or Directory.
  
  Updated boolean
  
  Has the document updated since the user signed
- OrgAccessDetails object
  
  Map Key - OrgId, Map Value - Org Access Detail(containing info about org admin and domain role)
  
  Hide OrgAccessDetails attribute Show OrgAccessDetails attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attributes Show * attributes object
  
  DomainRoleDetails array[object]
  
  Array of domain, role and status of domain role mapping
  
  Hide DomainRoleDetails attributes Show DomainRoleDetails attributes object
  
  AuthorisationDomainName string
  
  Format should match the following pattern: ^[^<>]*$.
  
  AuthorisationDomainRoleName string
  
  The authorisation domain role name
  
  Minimum length is 1, maximum length is 60. Format should match the following pattern: ^[^<>]*$.
  
  ContactRole string
  
  The name of the authorisation domain user type
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
  
  Status string
  
  Current status of this resource
  
  Values are Active or Inactive. Default value is Active.
  
  System string
  
  The name of the authorisation domain user type
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
  
  UserTypeID string
  
  Unique authorisation domain user type UUID
  
  Maximum length is 40. Format should match the following pattern: ^[^<>]*$.
  
  OrgAdmin boolean
  
  Is the user the org admin of the current org
  
  OrgRegistrationNumber string
  
  CNPJ/Registration number of the org
  
  Format should match the following pattern: ^[^<>]*$.
  
  OrganisationName string
  
  Name of the organisation.
  
  Maximum length is 255. Format should match the following pattern: ^[^<>]*$.
- SuperUser boolean
  
  Is the user a super user
- SystemUser boolean
  
  Is the user a system user
- UpdatedAt string(date-time)
401

Unauthorized
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
403

Forbidden
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
404 application/json

Not found
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
Hide response attribute Show response attribute object
- errors array[string]
  
  Validation Error messages
429

Too many requests, maximum capacity reached. Requests are now throttled.
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
500

Internal Server Error
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
502

Bad Gateway
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.
504

Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.
Hide headers attribute Show headers attribute
- x-fapi-interaction-id string
  
  An RFC4122 UID used as a correlation id.
  
  Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

GET /users/{UserEmailOrID}

curl \
 -X GET https://matls-api.sandbox.raidiam.io/users/{UserEmailOrID} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "x-fapi-auth-date: string" \
 -H "x-fapi-customer-ip-address: string" \
 -H "x-fapi-interaction-id: string" \
 -H "x-customer-user-agent: string"

Response examples (200)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "BasicInformation": {
    "Status": "Active",
    "UserEmail": "string",
    "UserID": "string"
  },
  "CertificationManager": true,
  "CreatedAt": "2025-05-04T09:42:00+00:00",
  "DataAdministrator": true,
  "DirectoryTermsAndConditionsDetails": {
    "RequiresSigning": true,
    "TermsAndConditionsItem": {
      "Content": "string",
      "Name": "string",
      "Status": "Active",
      "TnCId": 42,
      "Type": "Participant"
    },
    "Updated": true
  },
  "OrgAccessDetails": {
    "additionalProperty1": {
      "DomainRoleDetails": [
        {
          "AuthorisationDomainName": "string",
          "AuthorisationDomainRoleName": "PAGTO",
          "ContactRole": "string",
          "Status": "Active",
          "System": "string",
          "UserTypeID": "string"
        }
      ],
      "OrgAdmin": true,
      "OrgRegistrationNumber": "string",
      "OrganisationName": "string"
    },
    "additionalProperty2": {
      "DomainRoleDetails": [
        {
          "AuthorisationDomainName": "string",
          "AuthorisationDomainRoleName": "PAGTO",
          "ContactRole": "string",
          "Status": "Active",
          "System": "string",
          "UserTypeID": "string"
        }
      ],
      "OrgAdmin": true,
      "OrgRegistrationNumber": "string",
      "OrganisationName": "string"
    }
  },
  "SuperUser": true,
  "SystemUser": true,
  "UpdatedAt": "2025-05-04T09:42:00+00:00"
}

Response examples (404)

# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}