Skip to main content

Document entity

The Document entity is used to submit any supporting documentation that might be required for the merchant (i.e., an Account entity) and/or any of the merchant’s associated Contacts.

There are two steps required when sending documents to the uP POM via the Document entity:

  1. Attachment entity is sent with contents of the file. The file data is Base64 encoded before it is upload to the uP POM. The merchant onboarding API will return the Attachment ID.
  2. Next, the Document entity needs to be sent with the Attachment ID. This document needs to be linked to either the merchant (i.e., the Account entity) or a Contact entity.

See visual below.

Document entity

The table below captures the types of Documents that are required during the merchant underwriting and risk review.

Document NameDescriptionType
Business LicenseWhen uploading the "Business License" the uP POM expects to receive a Document with the Type "Business License" related to an AccountMandatory
Business PermitWhen uploading the "Business Permit" the uP POM expects to receive a Document with the Type "Business Permit" related to an AccountMandatory
Settlement Bank account(i.e., Bank Statement)When uploading the "Settlement Bank account License" the uP POM expects to receive a Document with the Type "Copy of settlement bank account" related to an AccountMandatory
Share RegistryWhen uploading the "Share Registry" the uP POM expects to receive a Document with the Type "Share Registry" related to an AccountMandatory
UBO – Government-issued IDWhen uploading the "UBO – Government-issued ID" the uP POM expects to receive a Document with the Type "Government-issued ID" related to a Contact with “contactClassification” contains “UBO”Conditional – only required if the “contactClassification” contains “UBO”