Skip to main content
GET
/
parties
Error
A valid request URL is required to generate request examples
{
  "Data": {
    "Party": {
      "PartyId": "<string>",
      "VerifiedClaims": [
        {
          "Verification": {
            "TrustFramework": "Undefined",
            "AssuranceLevel": "<string>",
            "AssuranceProcess": {
              "Policy": "<string>",
              "Procedure": "<string>",
              "AssuranceDetails": [
                {
                  "AssuranceType": "<string>",
                  "AssuranceClassification": "<string>",
                  "EvidenceRef": [
                    {
                      "Txn": "<string>",
                      "EvidenceMetadata": {
                        "EvidenceClassification": "<string>"
                      }
                    }
                  ]
                }
              ]
            },
            "Time": "2023-11-07T05:31:56Z",
            "VerificationProcess": "<string>",
            "Evidence": {
              "Type": "document",
              "CheckDetails": [
                {
                  "CheckMethod": "<string>",
                  "Organization": "<string>",
                  "Txn": "<string>",
                  "Time": "2023-11-07T05:31:56Z"
                }
              ],
              "Verifier": {
                "Organization": "<string>",
                "Txn": "<string>"
              },
              "Time": "2023-11-07T05:31:56Z",
              "DocumentDetails": {
                "Type": "passport",
                "DocumentNumber": "<string>",
                "PersonalNumber": "<string>",
                "SerialNumber": "<string>",
                "CalendarType": "IslamicCalendar",
                "DateOfIssuance": "2023-11-07T05:31:56Z",
                "DateOfExpiry": "2023-11-07T05:31:56Z",
                "Issuer": {
                  "Name": "<string>",
                  "Address": {
                    "Formatted": "<string>",
                    "StreetAddress": "<string>",
                    "Locality": "<string>",
                    "Region": "<string>",
                    "PostalCode": {
                      "PostalCode": "<string>"
                    },
                    "Country": {
                      "CountryCode": "<string>"
                    }
                  },
                  "CountryCode": {
                    "CountryCode": "<string>"
                  },
                  "Jurisdiction": "<string>"
                }
              },
              "Attachments": {
                "AEPartyIdentityEvidenceAttachments": [
                  {
                    "Desc": "<string>",
                    "ContentType": "<string>",
                    "Content": "<string>",
                    "Txn": "<string>"
                  }
                ]
              }
            }
          },
          "Claims": {
            "GivenName": "<string>",
            "Surname": "<string>",
            "MiddleName": "<string>",
            "Nickname": "<string>",
            "EmiratesId": "<string>",
            "EmiratesIdExpiryDate": "2023-12-25",
            "DateOfBirth": "2023-12-25",
            "SourceOfIncome": "<string>",
            "Salary": 123,
            "Nationality": "<string>",
            "ResidentialAddress": {
              "Formatted": "<string>",
              "StreetAddress": "<string>",
              "Locality": "<string>",
              "Region": "<string>",
              "PostalCode": {
                "PostalCode": "<string>"
              },
              "Country": {
                "CountryCode": "<string>"
              }
            },
            "MobileNumber": "<string>",
            "Email": "<string>",
            "MaritalStatus": "<string>",
            "Salutation": "<string>",
            "Language": "<string>",
            "EmployerName": "<string>",
            "EmploymentSinceDate": "2023-12-25",
            "PowerofAttorney": true,
            "SalaryTransfer": true,
            "Profession": "<string>",
            "UpdatedAt": "<string>"
          }
        }
      ],
      "PartyNumber": "<string>"
    }
  },
  "Links": {
    "Self": "<string>",
    "First": "<string>",
    "Prev": "<string>",
    "Next": "<string>",
    "Last": "<string>"
  },
  "Meta": {
    "TotalPages": 1
  }
}

Authorizations

​
Authorization
string
header
required

OAuth2 PAR flow, it is required when the User needs to perform SCA with the LFI when a TPP wants to access an LFI resource owned by the User. Please refer to OpenID FAPI Security Profile 1.0 -Part 2 Advanced - 5.2.2 point 14 - shall authenticate the confidential client using one of the following methods private_key_jwt and OpenID Connect Core 1.0 9. Client Authentication private_key_jwt

Headers

​
authorization
string
required

An authorization Token as per https://tools.ietf.org/html/rfc6750

​
x-customer-user-agent
string

Indicates the user-agent that the User is using.

​
x-fapi-auth-date
string

The time when the User 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

​
x-fapi-customer-ip-address
string

The User's IP address if the User is currently logged in with the TPP.

​
x-fapi-interaction-id
string

An RFC4122 UID used as a correlation id.

Response

The request has succeeded.

Current User Information

​
Data
object
required
​
Links
object
required

Links relevant to the resource

​
Meta
object
required

Meta Data relevant to the resource