Get person

GET 
https://sandbox.api.hubpay.ae/v1/account/persons/:personId

For business accounts - get details of a Shareholder, Director or Authorised Signatory

Request

Path Parameters

personId uuidrequired
Unique identifier of the related person
Example: e038b313-0b04-48d3-867e-7fee463501db

Header Parameters

AccountId stringrequired
ID of account for which operation is to be performed
Example: e038b313-0b04-48d3-867e-7fee463501db

Responses

200

OK

application/json

Schema

Schema

iduuidrequired

Unique identifier of the related person

statusstringrequired

Status of the related person in the onboarding or review process.

• NOT_SUBMITTED: The individual’s details have not yet been submitted for review.
• UNDER_REVIEW: The individual's information and documents are currently under review.
• ACTION_REQUIRED: The individual’s submission requires additional actions, such as uploading missing or invalid documents.
• APPROVED: The individual’s information has been reviewed and approved.

Possible values: [NOT_SUBMITTED, UNDER_REVIEW, ACTION_REQUIRED, APPROVED]

fullNameAsPerIdstringrequired

Full name of the individual exactly as it appears on their official identification document (e.g., passport or national ID)

documents object[]required

A list of documents associated with the individual

Array [

iduuidrequired

titlestringrequired

descriptionstringrequired

statusstringrequired

Possible values: [NOT_SUBMITTED, PENDING_REVIEW, DECLINED, APPROVED, PENDING_VERIFICATION, VALIDATION_WARNINGS]

requiredbooleanrequired

expiresAtdate-time

declinedReasonstring

Possible values: [NOT_CERTIFIED, INVALID_DOCUMENT_TYPE, QUALITY, OTHER_SEE_SUPPORT]

declinedCustomerDisplayReasonstring

lastUpdatedBystring

lastUpdatedAtdate-time

documentUploads object[]required

Array [

iduuidrequired

fileNamestringrequired

contentTypestringrequired

createdAtdate-timerequired

]

documentTypestringrequired

A list of documents attached for the individual. These documents should be uploaded first. See Upload Documents API for more details.

• PASSPORT: Mandatory for all individuals. Used for identity verification.
• EMIRATES_ID: Required for UAE residents as a government-issued ID.
• BANK_STATEMENT: Required for shareholders with 25% or more ownership only if the business dont not have a bank account. Must include the last 6 months of statements to verify financial standing and source of funds.
• CV: Required for Directors or UBOs only if the business do not have a bank account. Helps assess the individual’s professional background and experience.
• VALID_GOVERNMENT_ID: Required for Directors or UBOs only if the individual is NOT residing in the UAE (i.e. national ID, driver's license, etc).
• RESIDING_COUNTRY_PROOF_OF_ADDRESS: Required for Directors or UBOs only if the individual is NOT residing in the UAE (i.e. utility bill issued within 90 days or valid tenancy contract).

Possible values: [PASSPORT, EMIRATES_ID, BANK_STATEMENT, CV, VALID_GOVERNMENT_ID, RESIDING_COUNTRY_PROOF_OF_ADDRESS]

]

authorizedSignatorybooleanrequired

Indicates whether the individual has the authority to sign documents and make official commitments on behalf of the company

directorbooleanrequired

Indicates whether the individual is legally responsible for managing the company's operations and decision-making

shareholderbooleanrequired

Indicates whether the individual owns more than 25% of the company's shares

uaeResidentbooleanrequired

Indicates whether the individual resides in the UAE

linkedInProfileUrlstring

URL to the individual's LinkedIn profile, used for background and professional verification

Example (auto)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "NOT_SUBMITTED",
  "fullNameAsPerId": "string",
  "documents": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "description": "string",
      "status": "NOT_SUBMITTED",
      "required": true,
      "expiresAt": "2024-07-29T15:51:28.071Z",
      "declinedReason": "NOT_CERTIFIED",
      "declinedCustomerDisplayReason": "string",
      "lastUpdatedBy": "string",
      "lastUpdatedAt": "2024-07-29T15:51:28.071Z",
      "documentUploads": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "fileName": "string",
          "contentType": "string",
          "createdAt": "2024-07-29T15:51:28.071Z"
        }
      ],
      "documentType": "PASSPORT"
    }
  ],
  "authorizedSignatory": true,
  "director": true,
  "shareholder": true,
  "uaeResident": true,
  "linkedInProfileUrl": "string"
}

400

Bad Request

application/json

Schema

Schema

codestring
Stable machine-readable code
Possible values: [validation_failed, unauthorized, forbidden, not_found, conflict, internal_error, operation_unavailable]
Example: validation_failed
messagestring
Example: One or more fields are missing or invalid
statusint32
Example: 400
timestampdate-time
Example: 2025-06-10T10:15:31Z
pathstring
Example: /v1/collections/rates
errors object[]
Field-level validation errors
Array [
fieldstring
Example: sourceCurrency
messagestring
Example: Source currency is required
]

Example (auto)

{
  "code": "validation_failed",
  "message": "One or more fields are missing or invalid",
  "status": 400,
  "timestamp": "2025-06-10T10:15:31Z",
  "path": "/v1/collections/rates",
  "errors": [
    {
      "field": "sourceCurrency",
      "message": "Source currency is required"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

codestring
Stable machine-readable code
Possible values: [validation_failed, unauthorized, forbidden, not_found, conflict, internal_error, operation_unavailable]
Example: validation_failed
messagestring
Example: One or more fields are missing or invalid
statusint32
Example: 400
timestampdate-time
Example: 2025-06-10T10:15:31Z
pathstring
Example: /v1/collections/rates
errors object[]
Field-level validation errors
Array [
fieldstring
Example: sourceCurrency
messagestring
Example: Source currency is required
]

Example (auto)

{
  "code": "validation_failed",
  "message": "One or more fields are missing or invalid",
  "status": 400,
  "timestamp": "2025-06-10T10:15:31Z",
  "path": "/v1/collections/rates",
  "errors": [
    {
      "field": "sourceCurrency",
      "message": "Source currency is required"
    }
  ]
}

403

Forbidden

application/json

Schema

Schema

codestring
Stable machine-readable code
Possible values: [validation_failed, unauthorized, forbidden, not_found, conflict, internal_error, operation_unavailable]
Example: validation_failed
messagestring
Example: One or more fields are missing or invalid
statusint32
Example: 400
timestampdate-time
Example: 2025-06-10T10:15:31Z
pathstring
Example: /v1/collections/rates
errors object[]
Field-level validation errors
Array [
fieldstring
Example: sourceCurrency
messagestring
Example: Source currency is required
]

Example (auto)

{
  "code": "validation_failed",
  "message": "One or more fields are missing or invalid",
  "status": 400,
  "timestamp": "2025-06-10T10:15:31Z",
  "path": "/v1/collections/rates",
  "errors": [
    {
      "field": "sourceCurrency",
      "message": "Source currency is required"
    }
  ]
}

404

Not Found

application/json

Schema

Schema

codestring
Stable machine-readable code
Possible values: [validation_failed, unauthorized, forbidden, not_found, conflict, internal_error, operation_unavailable]
Example: validation_failed
messagestring
Example: One or more fields are missing or invalid
statusint32
Example: 400
timestampdate-time
Example: 2025-06-10T10:15:31Z
pathstring
Example: /v1/collections/rates
errors object[]
Field-level validation errors
Array [
fieldstring
Example: sourceCurrency
messagestring
Example: Source currency is required
]

Example (auto)

{
  "code": "validation_failed",
  "message": "One or more fields are missing or invalid",
  "status": 400,
  "timestamp": "2025-06-10T10:15:31Z",
  "path": "/v1/collections/rates",
  "errors": [
    {
      "field": "sourceCurrency",
      "message": "Source currency is required"
    }
  ]
}

405

Method Not Allowed

application/json

Schema

Schema

codestring
Stable machine-readable code
Possible values: [validation_failed, unauthorized, forbidden, not_found, conflict, internal_error, operation_unavailable]
Example: validation_failed
messagestring
Example: One or more fields are missing or invalid
statusint32
Example: 400
timestampdate-time
Example: 2025-06-10T10:15:31Z
pathstring
Example: /v1/collections/rates
errors object[]
Field-level validation errors
Array [
fieldstring
Example: sourceCurrency
messagestring
Example: Source currency is required
]

Example (auto)

{
  "code": "validation_failed",
  "message": "One or more fields are missing or invalid",
  "status": 400,
  "timestamp": "2025-06-10T10:15:31Z",
  "path": "/v1/collections/rates",
  "errors": [
    {
      "field": "sourceCurrency",
      "message": "Source currency is required"
    }
  ]
}

429

Too Many Requests

application/json

Schema

Schema

codestring
Stable machine-readable code
Possible values: [validation_failed, unauthorized, forbidden, not_found, conflict, internal_error, operation_unavailable]
Example: validation_failed
messagestring
Example: One or more fields are missing or invalid
statusint32
Example: 400
timestampdate-time
Example: 2025-06-10T10:15:31Z
pathstring
Example: /v1/collections/rates
errors object[]
Field-level validation errors
Array [
fieldstring
Example: sourceCurrency
messagestring
Example: Source currency is required
]

Example (auto)

{
  "code": "validation_failed",
  "message": "One or more fields are missing or invalid",
  "status": 400,
  "timestamp": "2025-06-10T10:15:31Z",
  "path": "/v1/collections/rates",
  "errors": [
    {
      "field": "sourceCurrency",
      "message": "Source currency is required"
    }
  ]
}

500

Internal Server Error

application/json

Schema

Schema

codestring
Stable machine-readable code
Possible values: [validation_failed, unauthorized, forbidden, not_found, conflict, internal_error, operation_unavailable]
Example: validation_failed
messagestring
Example: One or more fields are missing or invalid
statusint32
Example: 400
timestampdate-time
Example: 2025-06-10T10:15:31Z
pathstring
Example: /v1/collections/rates
errors object[]
Field-level validation errors
Array [
fieldstring
Example: sourceCurrency
messagestring
Example: Source currency is required
]

Example (auto)

{
  "code": "validation_failed",
  "message": "One or more fields are missing or invalid",
  "status": 400,
  "timestamp": "2025-06-10T10:15:31Z",
  "path": "/v1/collections/rates",
  "errors": [
    {
      "field": "sourceCurrency",
      "message": "Source currency is required"
    }
  ]
}

Authorization: http

name: Authorizationtype: httpdescription: JWT Bearer token for authenticating API requestsscheme: bearerbearerFormat: JWT

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://sandbox.api.hubpay.ae/v1/account/persons/:personId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://sandbox.api.hubpay.ae

Auth

Bearer Token

Parameters

personId — pathrequired

AccountId — headerrequired

ResponseClear

Click the Send API Request button above and see the response here!