Get document requirements
GEThttps://sandbox.api.hubpay.ae/v1/account/documents/required
Lists required documents for the account and their status
Request
Header Parameters
ID of account for which operation is to be performed
Responses
- 200
- 400
- 401
- 403
- 404
- 405
- 429
- 500
OK
- application/json
- Schema
- Example (auto)
Schema
documentRequirements object[]required
{
"documentRequirements": [
{
"documentType": "TRADE_LICENSE",
"title": "string",
"description": "string",
"required": true
}
]
}
Bad Request
- application/json
- Schema
- Example (auto)
Schema
Stable machine-readable code
Possible values: [validation_failed
, unauthorized
, forbidden
, not_found
, conflict
, internal_error
, operation_unavailable
]
validation_failed
One or more fields are missing or invalid
400
2025-06-10T10:15:31Z
/v1/collections/rates
errors object[]
{
"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"
}
]
}
Unauthorized
- application/json
- Schema
- Example (auto)
Schema
Stable machine-readable code
Possible values: [validation_failed
, unauthorized
, forbidden
, not_found
, conflict
, internal_error
, operation_unavailable
]
validation_failed
One or more fields are missing or invalid
400
2025-06-10T10:15:31Z
/v1/collections/rates
errors object[]
{
"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"
}
]
}
Forbidden
- application/json
- Schema
- Example (auto)
Schema
Stable machine-readable code
Possible values: [validation_failed
, unauthorized
, forbidden
, not_found
, conflict
, internal_error
, operation_unavailable
]
validation_failed
One or more fields are missing or invalid
400
2025-06-10T10:15:31Z
/v1/collections/rates
errors object[]
{
"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"
}
]
}
Not Found
- application/json
- Schema
- Example (auto)
Schema
Stable machine-readable code
Possible values: [validation_failed
, unauthorized
, forbidden
, not_found
, conflict
, internal_error
, operation_unavailable
]
validation_failed
One or more fields are missing or invalid
400
2025-06-10T10:15:31Z
/v1/collections/rates
errors object[]
{
"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"
}
]
}
Method Not Allowed
- application/json
- Schema
- Example (auto)
Schema
Stable machine-readable code
Possible values: [validation_failed
, unauthorized
, forbidden
, not_found
, conflict
, internal_error
, operation_unavailable
]
validation_failed
One or more fields are missing or invalid
400
2025-06-10T10:15:31Z
/v1/collections/rates
errors object[]
{
"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"
}
]
}
Too Many Requests
- application/json
- Schema
- Example (auto)
Schema
Stable machine-readable code
Possible values: [validation_failed
, unauthorized
, forbidden
, not_found
, conflict
, internal_error
, operation_unavailable
]
validation_failed
One or more fields are missing or invalid
400
2025-06-10T10:15:31Z
/v1/collections/rates
errors object[]
{
"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"
}
]
}
Internal Server Error
- application/json
- Schema
- Example (auto)
Schema
Stable machine-readable code
Possible values: [validation_failed
, unauthorized
, forbidden
, not_found
, conflict
, internal_error
, operation_unavailable
]
validation_failed
One or more fields are missing or invalid
400
2025-06-10T10:15:31Z
/v1/collections/rates
errors object[]
{
"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/documents/required");
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());