Add/update document

POST 
https://api.hubpay.ae/v1/account/documents

Add/update a document by type. If the document already exists, it will be updated with the new file. If the document does not exist, it will be created.

Request

Header Parameters

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

application/json

Bodyrequired

documentTypestringrequired

Document type identifier for the document requirement. See Get document requirements API

Allowed values:

• TRADE_LICENSE: Valid Trade/Commercial license
• MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION: Memorandum of Association or Articles of Association
• BUSINESS_PROOF_OF_ADDRESS: Valid proof of business address
• POWER_OF_ATTORNEY: Power of attorney or Board resolution
• BANK_STATEMENT: 3 months bank statement
• LATEST_AUDITED_FINANCIAL_STATEMENTS: Latest Audited Financial Statements
• LETTER_OF_AUTHORISATION_WITH_TERMS_AND_CONDITIONS: Letter of Authorisation (with Terms and Conditions)

Possible values: [TRADE_LICENSE, MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION, BUSINESS_PROOF_OF_ADDRESS, POWER_OF_ATTORNEY, BANK_STATEMENT, LATEST_AUDITED_FINANCIAL_STATEMENTS, LETTER_OF_AUTHORISATION_WITH_TERMS_AND_CONDITIONS, INVESTMENT_AGREEMENT]

documentUploadIdsuuid[]required

One or more document upload IDs associated with this document type. See /account/{id}/document/upload

Responses

201

Created

application/json

Schema

Schema

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

Document type identifier for the document requirement.

Allowed values:

• TRADE_LICENSE: Valid Trade/Commercial license
• MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION: Memorandum of Association or Articles of Association
• BUSINESS_PROOF_OF_ADDRESS: Valid proof of business address
• POWER_OF_ATTORNEY: Power of attorney or Board resolution
• BANK_STATEMENT: 3 months bank statement
• LATEST_AUDITED_FINANCIAL_STATEMENTS: Latest Audited Financial Statements
• LETTER_OF_AUTHORISATION_WITH_TERMS_AND_CONDITIONS: Letter of Authorisation (with Terms and Conditions)

Possible values: [TRADE_LICENSE, MEMORANDUM_OF_ASSOCIATION_OR_ARTICLES_OF_ASSOCIATION, BUSINESS_PROOF_OF_ADDRESS, POWER_OF_ATTORNEY, BANK_STATEMENT, LATEST_AUDITED_FINANCIAL_STATEMENTS, LETTER_OF_AUTHORISATION_WITH_TERMS_AND_CONDITIONS, INVESTMENT_AGREEMENT]

Example (auto)

{
  "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": "TRADE_LICENSE"
}

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"
    }
  ]
}

415

Unsupported Media Type

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.Post, "https://api.hubpay.ae/v1/account/documents");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"documentType\": \"TRADE_LICENSE\",\n  \"documentUploadIds\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ]\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.hubpay.ae

Auth

Bearer Token

Parameters

AccountId — headerrequired

Body required

{
  "documentType": "TRADE_LICENSE",
  "documentUploadIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}

ResponseClear

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