Whitelist Depositor

For each reciever, you need to create a beneficiary on the platform. We will return a beneficiaryId, which can be used to make transfers.

We will run an AML and Sanctions check on them once added into the platform.

Endpoint : POST https://api.zamplabs.com/api/v1/depositor

CreateDepositorRequest Struct Documentation

The CreateDepositorRequest struct is used to add a depositor, capturing all necessary details about the depositor, their business, and associated company owners. Below is a detailed explanation of the struct fields and their JSON representation.

Request Body

Key	Type	Description	Required
depositor_relation	string	The relationship of the depositor to the entity.	Yes
depositor_type	string	The type of depositor ( Individual, Corporate).	Yes
depositor_details	DepositorDetails	Detailed personal information of the depositor.	Yes
depositor_business_details	DepositorBusinessDetails	Detailed information of the depositor's business.	Yes
company_owner_details	[]CompanyOwnerDetails	List of owners of the company, including their personal details and documents.	Yes
depositor_wallet_address	string	The wallet address of the depositor.	Yes
depositor_business_id	string	The business ID of the depositor.	Yes

DepositorDetails

Key	Type	Description	Required
person_details	PersonDetails	Personal details of the depositor.	Yes
address	Address	Address of the depositor.	Yes
documents	Documents	Documents related to the depositor.	Yes

DepositorBusinessDetails

Key	Type	Description	Required
business_identification_number	string	The business identification number.	Yes
name	string	The name of the business.	Yes
business_type	string	The type of business.	Yes
date_of_incorporation	string	The date of incorporation of the business.	Yes
address	Address	The address of the business.	Yes

CompanyOwnerDetails

Key	Type	Description	Required
person_details	PersonDetails	Personal details of the company owner.	Yes
documents	Documents	Documents related to the company owner.	Yes

Address

Key	Type	Description	Required
address1	string	The primary address line.	Yes
city	string	The city of the address.	Yes
country	string	The country of the address.	Yes
state	string	The state of the address.	Yes
zip_code	string	The ZIP code of the address.	Yes

Documents

Key	Type	Description	Required
document_type	string	The type of document (e.g., passport, driver's license).	Yes
document_number	string	The document number.	Yes

PersonDetails

Key	Type	Description	Required
firstname	string	The first name of the person.	Yes
lastname	string	The last name of the person.	Yes
citizenship	string	The citizenship of the person.	Yes
country_of_birth	string	The country of birth of the person.	Yes
date_of_birth	string	The date of birth of the person.	Yes

Request JSON Representation of Depositor type Individual

Below is an example JSON representation of a CreateDepositorRequest with test data:

{
  "depositor_relation": "external",
  "depositor_type": "Individual",
  "depositor_details": {
    "person_details": {
      "firstname": "Prince",
      "lastname": "Kumar",
      "citizenship": "IN",
      "country_of_birth": "IN",
      "date_of_birth": "2000-09-09"
    },
    "address": {
      "address1": "test",
      "city": "test",
      "country": "IN",
      "state": "test",
      "zip_code": "1112211"
    },
    "documents": {
      "document_type": "DRIVING_LICENSE",
      "document_number": "839129181129"
    }
  }
}

Request JSON Representation of Depositor type Corporate

{
  "depositor_relation": "external",
  "depositor_type": "Corporate",
  "depositor_business_details": {
    "business_identification_number": "312312321321312",
    "name": "test",
    "business_type": "LIMITED_LIABILITY_COMPANY",
    "date_of_incorporation": "2008-09-09",
    "address": {
      "address1": "test",
      "city": "test",
      "country": "US",
      "state": "Ohio",
      "zip_code": "43057"
    }
  },
  "company_owner_details": [
    {
      "person_details": {
        "firstname": "john",
        "lastname": "doe",
        "citizenship": "US",
        "country_of_birth": "US",
        "date_of_birth": "2008-09-09"
      },
      "documents": {
        "document_type": "DRIVING_LICENSE",
        "document_number": "832902819201"
      }
    }
  ],
  "depositor_wallet_address": "0x1f9090aaE28b8a3dCeaDf281B0F12828e676c326"
}

Request JSON Representation of Self Business Depositor

{
        "depositor_relation": "business",
        "depositor_wallet_address":"0x4838B106FCe9647Bdf1E7877BF73cE8B0BAD5f87",
        "depositor_business_id":"tef24d_kWe54ytTx5NckcDamRXimG_04_29"

}

Response Body

Key	Value	Description
id	merchant_jXHm4aJH4vUmgcT6bmYGwD_11_30	This is the UUID with which you can uniquely identify depositor on Roma platform

Response JSON Representation

{
    "data": {
        "id": "8ydue4_etoywLsSS88XDVspB2yEd6_05_22"
    }
}

Error Codes

HTTP Code	Error Response	Description
404	{"code":"RECORD_NOT_FOUND","message":"Unable to find the record requested."}	Failed to find the configuration required to add the Beneficiary for the Merchant. Please contact the Zamp team if this happens
403	{"code":"BENEFICIARY_CREATION_NOT_ALLOWED","message":"Beneficiary creation not allowed"}	The Merchant is not allowed to create a beneficiary.