Partner API — v2.8.0

Type: Minor Release · Previous version: v2.7.0

✅ 14 New ✏️ 1 Modified 🚫 4 Deprecated

✅ New Endpoints

GET `/cards/details`

Tag: Card
Summary: Retrieve card details by account and namespace

Retrieves detailed information for a card based on account, wallet, and namespace filters. This includes product metadata, card plan, customer linkages, balance info, and design elements. Used for full profile views of a debit card on customer service dashboards or in audits.

Filters include (any one) to get cards tied to a specific wallet:

walletAddress, or
nameSpace, or
customNameSpace

Supports bearer-token in authorization.

Card Statuses:

1000: Fully operational 1001: Refer to issuer 1004: Capture card 1005: Decline all transactions 1007: Decline all transactions 1008: Honor with ID 1041: Lost card - Capture 1043: Stolen card - Capture 1054: Expired card - Report 1140: Lost card - No capture 1143: Stolen card - No capture 1154: Expired card - Do not inform 1062: Restricted card

Query Parameters

Parameter	Type	Required	Description
`walletAddress`	string	No	Wallet Address
`customNameSpace`	string	No	CustomNameSpace
`nameSpace`	string	No	NameSpace

Response Codes

Code	Description
200	Successfully retrieved card details
400	Error response when fetching card details because card is not present
401	Error when fetching card details due to invalid bearer token
403	Error when fetching card details because bearer token is invalid
500	Error when fetching card details due to server error

200 — Successfully retrieved card details

{
  "message": "Card details fetched successfully",
  "data": {
    "cardNumber": "4219220000005986",
    "cardHolderName": "John Doe",
    "expiryDate": "2025-04-29",
    "cvv": "694",
    "cardType": "VISA",
    "status": "Temporary block"
  }
}

400 — Error response when fetching card details because card is not present

{
  "errors": [
    {
      "type": "Not found",
      "message": "Details not found, Please make sure details are correct."
    }
  ]
}

401 — Error when fetching card details due to invalid bearer token

{
  "errors": [
    {
      "type": "API Key",
      "message": "Invalid API Key"
    }
  ]
}

403 — Error when fetching card details because bearer token is invalid

{
  "errors": [
    {
      "type": "Access control",
      "message": "Access denied for this resource"
    }
  ]
}

500 — Error when fetching card details due to server error

{
  "errors": [
    {
      "type": "Internal server error",
      "message": "An unexpected error occurred. Please try again later"
    }
  ]
}

GET `/cards/eligible-cards`

Tag: Card
Summary: Retrieve a list of all eligible debit cards

Retrieves a list of eligible debit cards for a walletAddress, nameSpace, or customNameSpace.

This endpoint is used to display eligible cards that can be requested to a wallet.

Filters include (any one of):

walletAddress
nameSpace
customNameSpace

Supports bearer-token in authorization.

Query Parameters

Parameter	Type	Required	Description
`walletAddress`	string	No	Wallet Address
`customNameSpace`	string	No	CustomNameSpace
`nameSpace`	string	No	NameSpace

Response Codes

Code	Description
200	Successfully retrieved the list of available debit cards
400	Error response when fetching available debit cards because customNameSpace is not correct
401	Error response when fetching available debit cards due to invalid bearer token
403	Error response when fetching available debit cards because bearer token is invalid
500	Error response when fetching available debit cards due to server error

200 — Successfully retrieved the list of available debit cards

{
  "message": "Select available product options",
  "data": [
    {
      "cardProductId": "7d405976-87f5-47a1-aa23-76a4ee8e63d0",
      "isActive": true,
      "createdAt": "2025-06-02T06:01:50.9030000+00:00",
      "updatedAt": "2025-06-02T06:01:50.9030000+00:00",
      "productVendorId": "23d2c6c8-2458-4537-8c10-f4f64ff995bd",
      "productTypeId": "6d2fdf75-0acf-4d94-8ae6-910d6269b42d",
      "vendorDssTypeId": "fc902297-b48c-4e85-9530-623670af3fde",
      "productName": "Via Carte Debit Card New",
      "productVendorName": "VIACARTE",
      "productTypeName": "DEBIT CARD"
    }
  ]
}

400 — Error response when fetching available debit cards because customNameSpace is not correct

{
  "errors": [
    {
      "type": "Not found",
      "message": "Details not found, Please make sure details are correct."
    }
  ]
}

401 — Error response when fetching available debit cards due to invalid bearer token

{
  "errors": [
    {
      "type": "API Key",
      "message": "Invalid API Key"
    }
  ]
}

403 — Error response when fetching available debit cards because bearer token is invalid

{
  "errors": [
    {
      "type": "Access control",
      "message": "Access denied for this resource"
    }
  ]
}

500 — Error response when fetching available debit cards due to server error

{
  "errors": [
    {
      "type": "Internal server error",
      "message": "An unexpected error occurred. Please try again later"
    }
  ]
}

GET `/federate-id/file-upload-status`

Tag: Federated Id Management
Summary: Get status of uploaded Fed ID bulk upload CSV file

Query Parameters

Parameter	Type	Required	Description
`fileId`	string	Yes	File Id e.g. `fileId`

Response Codes

Code	Description
200	file status fetched successfully.
400	Invalid file id.
401	Unauthorized.
403	Forbidden.
500	Server error.

200 — file status fetched successfully.

{
  "message": "Fed ID bulk upload status fetched successfully",
  "data": {
    "fileName": "fed_id_allocation.csv",
    "status": "processing",
    "isAccepted": true,
    "duplicateCsvUrl": "https://storage.blob.core.windows.net/duplicates/duplicate.csv",
    "reason": "File contains invalid data format"
  }
}

400 — Invalid file id.

{
  "errors": [
    {
      "type": "catch",
      "message": "CSV log entry not found"
    }
  ]
}

401 — Unauthorized.

{
  "errors": [
    {
      "type": "Invalid",
      "message": "Invalid Tenant Id"
    }
  ]
}

403 — Forbidden.

{
  "errors": [
    {
      "type": "Access Control",
      "message": "Access denied for this resource"
    }
  ]
}

500 — Server error.

{
  "errors": [
    {
      "type": "Internal server error",
      "message": "An unexpected error occurred. Please try again later"
    }
  ]
}

GET `/federate-id/linked`

Tag: Federated Id Management
Summary: Retrieve linked bank account by federatedId, walletAddress or bankAccountNumber

Query Parameters

Parameter	Type	Required	Description
`bankAccountNumber`	string	No	Bank Account Number e.g. `1234567890`
`walletAddress`	string	No	Wallet Address e.g. `0x1234567890`
`federatedId`	string	No	Federated Id e.g. `FE-1234567890`

Response Codes

Code	Description
200	Linked bank account details retrieved successfully.
400	Missing or invalid query parameters.
401	Error response when user is unauthorized.
403	Error response when user is forbidden.
500	Error response when internal server error.

200 — Linked bank account details retrieved successfully.

{
  "message": "Linked accounts fetched successfully",
  "data": [
    {
      "bankAccountNumber": "12132",
      "federatedId": "12132",
      "walletAddress": "12132",
      "abaNumber": "12132",
      "createdAt": "2020-08-01"
    }
  ]
}

400 — Missing or invalid query parameters.

{
  "errors": [
    {
      "type": "Federated Id",
      "message": "Bank accounts not found"
    }
  ]
}

401 — Error response when user is unauthorized.

{
  "errors": [
    {
      "type": "Invalid",
      "message": "Invalid Tenant Id"
    }
  ]
}

403 — Error response when user is forbidden.

{
  "errors": [
    {
      "type": "Access Control",
      "message": "Access denied for this resource"
    }
  ]
}

500 — Error response when internal server error.

{
  "error": {
    "type": "Internal server error",
    "message": "An unexpected error occurred. Please try again later"
  }
}

PATCH `/cards/block-unblock`

Tag: Card
Summary: Change the status of a debit card (e.g. block, unblock)

Updates the status of a specific debit card to a new status value, such as block or unblock. The status code and reason must be provided in the request body. This is typically used to temporarily disable or re-enable a card for operational or security reasons.

Requires: bearer-token in authorization.

Request Body

Field	Type	Required	Description
`block`	boolean	Yes	block e.g. `False`
`reason`	string	Yes	reason for updating card status e.g. `User requested temporary block`
`walletAddress`	string	No	WalletAddress
`customNameSpace`	string	No	CustomNameSpace
`nameSpace`	string	No	NameSpace

Example Request

{
  "block": false,
  "reason": "User requested temporary block",
  "walletAddress": "string",
  "customNameSpace": "string",
  "nameSpace": "string"
}

Response Codes

Code	Description
200	Card status updated successfully
400	Error response when updating card status because card details are not present
401	Error when updating card status due to invalid bearer token
403	Error when updating card status because bearer token is invalid
500	Error when updating card status due to server error

200 — Card status updated successfully

{
  "message": "Card status updated successfully",
  "data": {
    "status": "Temporary block"
  }
}

400 — Error response when updating card status because card details are not present

{
  "errors": [
    {
      "type": "Not found",
      "message": "Card Details Not Found"
    }
  ]
}

401 — Error when updating card status due to invalid bearer token

{
  "errors": [
    {
      "type": "API Key",
      "message": "Invalid API Key"
    }
  ]
}

403 — Error when updating card status because bearer token is invalid

{
  "errors": [
    {
      "type": "Access control",
      "message": "Access denied for this resource"
    }
  ]
}

500 — Error when updating card status due to server error

{
  "errors": [
    {
      "type": "Internal server error",
      "message": "An unexpected error occurred. Please try again later"
    }
  ]
}

POST `/cards/report/lost`

Tag: Card
Summary: Report a debit card as lost

Marks a specific debit card as lost. This operation updates the card status to a lost code. Requires: bearer-token in authorization

Request Body

Field	Type	Required	Description
`reason`	string	Yes	reason for updating card status e.g. `User reported`
`walletAddress`	string	No	WalletAddress
`customNameSpace`	string	No	CustomNameSpace
`nameSpace`	string	No	NameSpace
`reportDate`	string	Yes	Date of card lost (YYYY-MM-DD) Format: `date` e.g. `2025-06-13`

Example Request

{
  "reason": "User reported",
  "walletAddress": "string",
  "customNameSpace": "string",
  "nameSpace": "string",
  "reportDate": "2025-06-13"
}

Response Codes

Code	Description
200	Card successfully marked as lost
400	Error response when updating card status because card details are not present
401	Error when updating card status due to invalid bearer token
403	Error when updating card status because bearer token is invalid
500	Error when updating card status due to server error

200 — Card successfully marked as lost

{
  "message": "Card status updated successfully",
  "data": {
    "status": "Lost"
  }
}

400 — Error response when updating card status because card details are not present

{
  "errors": [
    {
      "type": "Not found",
      "message": "Card Details Not Found"
    }
  ]
}

401 — Error when updating card status due to invalid bearer token

{
  "errors": [
    {
      "type": "API Key",
      "message": "Invalid API Key"
    }
  ]
}

403 — Error when updating card status because bearer token is invalid

{
  "errors": [
    {
      "type": "Access control",
      "message": "Access denied for this resource"
    }
  ]
}

500 — Error when updating card status due to server error

{
  "errors": [
    {
      "type": "Internal server error",
      "message": "An unexpected error occurred. Please try again later"
    }
  ]
}

POST `/cards/report/stolen`

Tag: Card
Summary: Report a debit card as stolen

Marks a specific debit card as stolen. This operation updates the card status to a stolen code. Requires: bearer-token in authorization

Request Body

Field	Type	Required	Description
`reason`	string	Yes	reason for updating card status e.g. `User reported`
`walletAddress`	string	No	WalletAddress
`customNameSpace`	string	No	CustomNameSpace
`nameSpace`	string	No	NameSpace
`reportDate`	string	Yes	Date of card lost (YYYY-MM-DD) Format: `date` e.g. `2025-06-13`

Example Request

{
  "reason": "User reported",
  "walletAddress": "string",
  "customNameSpace": "string",
  "nameSpace": "string",
  "reportDate": "2025-06-13"
}

Response Codes

Code	Description
200	Card successfully marked as stolen
400	Error response when updating card status because card details are not present
401	Error when updating card status due to invalid bearer token
403	Error when updating card status because bearer token invalid
500	Error when updating card status due to server error

200 — Card successfully marked as stolen

{
  "message": "Card status updated successfully",
  "data": {
    "status": "Stolen"
  }
}

400 — Error response when updating card status because card details are not present

{
  "errors": [
    {
      "type": "Not found",
      "message": "Card Details Not Found"
    }
  ]
}

401 — Error when updating card status due to invalid bearer token

{
  "errors": [
    {
      "type": "API Key",
      "message": "Invalid API Key"
    }
  ]
}

403 — Error when updating card status because bearer token invalid

{
  "errors": [
    {
      "type": "Access control",
      "message": "Access denied for this resource"
    }
  ]
}

500 — Error when updating card status due to server error

{
  "errors": [
    {
      "type": "Internal server error",
      "message": "An unexpected error occurred. Please try again later"
    }
  ]
}

POST `/cards/request-card`

Tag: Card
Summary: Request a new debit card

Request a new debit card for a customer. Requires customer account ID, selected product ID, and optional wallet or namespace identifiers.

The endpoint generates a card tied to the customer wallet, product plan, and issuer.

Supports bearer-token in authorization.

Request Body

Field	Type	Required	Description
`walletAddress`	string	No	wallet address
`customNameSpace`	string	No	CustomNameSpace
`nameSpace`	string	No	NameSpace
`cardProductId`	string	Yes	Debit Card Product Id
`tokenSymbol`	string	Yes	Token symbol

Example Request

{
  "walletAddress": "string",
  "customNameSpace": "string",
  "nameSpace": "string",
  "cardProductId": "string",
  "tokenSymbol": "string"
}

Response Codes

Code	Description
201	Created response after debit card issued successfully
400	Error response when issuing debit cards because customNameSpace is not correct
401	Error response when issuing debit cards due to invalid bearer token
403	Error response when issuing debit cards because bearer token is invalid
500	Error response when issuing debit cards due to server error

201 — Created response after debit card issued successfully

{
  "message": "Debit card issued successfully",
  "data": {
    "cardNumber": "4219220000005986",
    "cardHolderName": "John Doe",
    "expiryDate": "2025-04-29",
    "cvv": "694",
    "cardType": "VISA",
    "status": "Temporary block"
  }
}

400 — Error response when issuing debit cards because customNameSpace is not correct

{
  "errors": [
    {
      "type": "Not found",
      "message": "Details not found, Please make sure details are correct."
    }
  ]
}

401 — Error response when issuing debit cards due to invalid bearer token

{
  "errors": [
    {
      "type": "API Key",
      "message": "Invalid API Key"
    }
  ]
}

403 — Error response when issuing debit cards because bearer token is invalid

{
  "errors": [
    {
      "type": "Access control",
      "message": "Access denied for this resource"
    }
  ]
}

500 — Error response when issuing debit cards due to server error

{
  "errors": [
    {
      "type": "Internal server error",
      "message": "An unexpected error occurred. Please try again later"
    }
  ]
}

POST `/federate-id/file-upload`

Tag: Federated Id Management
Summary: Upload a CSV file containing Fed ID allocations

Upload a CSV file containing Fed ID, Wallet Address, Bank Account Number (optional), and ABA Number (optional)

Request Body

Field	Type	Required	Description
`file`	string	Yes	Format: `binary`

Example Request

{
  "file": "<string>"
}

Response Codes

Code	Description
200	CSV processed successfully.
400	Invalid CSV or missing file.
401	Unauthorized.
403	Forbidden.
500	Server error.

200 — CSV processed successfully.

{
  "data": {
    "message": "Fed ID bulk upload successful. Processing has started.",
    "fileId": "1234567890"
  }
}

400 — Invalid CSV or missing file.

{
  "errors": [
    {
      "type": "file",
      "message": "File is required."
    }
  ]
}

401 — Unauthorized.

{
  "errors": [
    {
      "type": "Invalid",
      "message": "Invalid Tenant Id"
    }
  ]
}

403 — Forbidden.

{
  "errors": [
    {
      "type": "Access Control",
      "message": "Access denied for this resource"
    }
  ]
}

500 — Server error.

{
  "errors": [
    {
      "type": "Internal server error",
      "message": "An unexpected error occurred. Please try again later"
    }
  ]
}

POST `/federate-id/link`

Tag: Federated Id Management
Summary: Link a bank account to a wallet address

Request Body

Field	Type	Required	Description
`walletAddress`	string	Yes	wallet address
`federatedId`	string	Yes	federated Id

Example Request

{
  "walletAddress": "string",
  "federatedId": "string"
}

Response Codes

Code	Description
201	Bank account successfully linked to wallet
400	Invalid input or bank account already linked
401	Error response when user is unauthorized.
403	Error response when user is forbidden.
500	Server error

201 — Bank account successfully linked to wallet

{
  "message": "Bank account linked successfully",
  "data": {
    "federatedId": "125AH",
    "bankAccountNumber": "2123",
    "walletAddress": "1234567890",
    "abaNumber": "1234567890"
  }
}

400 — Invalid input or bank account already linked

{
  "errors": [
    {
      "type": "Federated Id",
      "message": "Wallet address or Federated Id already linked"
    }
  ]
}

401 — Error response when user is unauthorized.

{
  "errors": [
    {
      "type": "Invalid",
      "message": "Invalid Tenant Id"
    }
  ]
}

403 — Error response when user is forbidden.

{
  "errors": [
    {
      "type": "Access Control",
      "message": "Access denied for this resource"
    }
  ]
}

500 — Server error

{
  "error": {
    "type": "Internal server error",
    "message": "An unexpected error occurred. Please try again later"
  }
}

POST `/transaction/confirmation-requests`

Tag: Payment
Summary: API Version V2.0.0 | initiate the confirmation request for deposit for minting tokens

Request Body

Field	Type	Required	Description
`depositRequestId`	number	Yes	deposit Request Id e.g. `5822e56e-1909-426f-a4be-1d49b15c781c`
`amount`	number	Yes	amount e.g. `5`
`token`	string	Yes	token
`walletIdentifier`	string	Yes	Custom Namespace or Wallet address of user e.g. `testbronze01 or 0xB47deb51aEEf5C1732E09CBF20adF4C0e8F22947`
`walletIdentifierType`	string	Yes	Type of wallet identifier e.g. `CUSTOM NAMESPACE or WALLET ADDRESS`
`confirm`	string	Yes	confirmation for the request e.g. `YES or NO`

Example Request

{
  "depositRequestId": "5822e56e-1909-426f-a4be-1d49b15c781c",
  "amount": 5,
  "token": "string",
  "walletIdentifier": "testbronze01 or 0xB47deb51aEEf5C1732E09CBF20adF4C0e8F22947",
  "walletIdentifierType": "CUSTOM NAMESPACE or WALLET ADDRESS",
  "confirm": "YES or NO"
}

Response Codes

Code	Description
201	Success Response when confirmation request is submitted successfully
400	Error response for all possible cases when api gets failed.

201 — Success Response when confirmation request is submitted successfully

{
  "data": {
    "requestId": "facc46b7-9988-482c-bf42-7a2cf8f97f72",
    "tenantId": "4e6cb408-8a22-4edc-ba0f-e0f8071efc64",
    "amount": 35,
    "token": "THIS",
    "rejectionReason": "",
    "statusStage": "FINAL",
    "status": "COMPLETED",
    "data": {
      "namespace": "digit.thirusilver11s.ul",
      "transactionId": "2bfd5f84-5ea1-4a05-b7f6-a3ebb104b9ff",
      "amount": 35,
      "paymentStatus": "APPROVED",
      "tokenMintStatus": "PENDING",
      "cardTransactionHistory": [
        {
          "transactionHistoryId": "11bc5cd3-e515-4f8d-ba63-d1982d3ff946",
          "status": "APPROVED",
          "description": "token minting status is approved",
          "createdAt": "2023-12-21T11:31:20.0000000+00:00"
        },
        {
          "transactionHistoryId": "373e2f59-a41a-463a-8750-0e3c7e96116b",
          "status": "DEPOSIT-REQUEST-SUCCESS",
          "description": "transaction status is deposit-request-success",
          "createdAt": "2023-12-21T11:31:22.0000000+00:00"
        }
      ]
    }
  },
  "message": "Confirmation request submitted successfully"
}

400 — Error response for all possible cases when api gets failed.

{
  "errors": [
    {
      "type": "catch",
      "message": "error message"
    },
    {
      "type": "catch",
      "message": "Successfully Invalidated Confirmation Request. No further action possible for the same request."
    },
    {
      "type": "catch",
      "message": "Initiation of deposit request got failed"
    }
  ]
}

POST `/transaction/deposit-requests`

Tag: Payment
Summary: initiate the deposit requests for minting tokens

Request Body

Field	Type	Required	Description
`amount`	number	Yes	amount e.g. `5`
`token`	string	Yes	Token \| under which token that amount to be transferred e.g. `THIS`
`walletIdentifier`	string	Yes	Custom Namespace or Wallet address of user e.g. `testbronze01 or 0xB47deb51aEEf5C1732E09CBF20adF4C0e8F22947`
`walletIdentifierType`	string	Yes	Type of wallet identifier e.g. `CUSTOM NAMESPACE or WALLET ADDRESS`

Example Request

{
  "amount": 5,
  "token": "THIS",
  "walletIdentifier": "testbronze01 or 0xB47deb51aEEf5C1732E09CBF20adF4C0e8F22947",
  "walletIdentifierType": "CUSTOM NAMESPACE or WALLET ADDRESS"
}

Response Codes

Code	Description
201	Success Response when request is submitted successfully
400	Error response for all possible cases when api gets failed.

201 — Success Response when request is submitted successfully

{
  "data": {
    "amount": "25",
    "token": "THIS",
    "walletIdentifier": "digit_testsiveruserdigitte1_ul",
    "walletIdentifierType": "CUSTOM NAMESPACE",
    "tenantId": "4e6cb408-8a22-4edc-ba0f-e0f8071efc64",
    "rejectionReason": "Deposit not allowed",
    "statusStage": "FINAL",
    "status": "Rejected request due to validation failures",
    "created_at": "2023-12-09T10:26:47.0000000+00:00",
    "depositRequestId": "5822e56e-1909-426f-a4be-1d49b15c781c"
  },
  "message": "Deposit request submitted successfully"
}

400 — Error response for all possible cases when api gets failed.

{
  "errors": [
    {
      "type": "catch",
      "message": "error message"
    },
    {
      "type": "catch",
      "message": "Initiation of deposit request got failed"
    }
  ]
}

POST `/transaction/exchange-plaid-token`

Tag: Payment
Summary: Create Exchange Plaid token for a customer

Create link token for a customer

Request Body

Field	Type	Required	Description
`publicToken`	string	Yes	userId

Example Request

{
  "publicToken": "string"
}

Response Codes

Code	Description
201	Success response when link token created successfully
400	Error response when create link token api gets failed.

POST `/transaction/plaid-link-token`

Tag: Payment
Summary: Create link token for a customer

Request Body

Field	Type	Required	Description
`userId`	string	Yes	userId

Example Request

{
  "userId": "string"
}

Response Codes

Code	Description
201	Success response when link token created successfully
400	Error response when create link token api gets failed.

✏️ Modified Endpoints

POST `/tenant/customer`

Tag: Tenant Customers
Summary: Onboard tenant customer

Updated Request Body Fields

accountAddress (string)

Description updated:
Before: account address of customer
After: account address of customer (must be valid ethereum address)
Example updated: 0xAbC1234567890abcdefABC1234567890abcdefAB

Current Request Example

{
  "identificationBadgeId": "string",
  "firstName": "Jone",
  "middleName": "string",
  "lastName": "Doe",
  "fullName": "Jone Doe",
  "accountAddress": "0xAbC1234567890abcdefABC1234567890abcdefAB",
  "customerMetaData": {},
  "tenantId": "e1e9adb4-d3bd-4ba5-98b8-011c03a9d2b1",
  "customNamespace": "jonedoe",
  "provider": "ens",
  "ulNamespace": "digit.sam.ul",
  "maritalStatus": [
    "married",
    "unmarried"
  ],
  "dateOfBirth": "1997-02-02",
  "email": "lorem@mygmail.com",
  "gender": "unknown",
  "phoneNumber": "+91123456789",
  "nationality": "string",
  "ip_address": "string",
  "ssn": "string",
  "stateLicenseId": "string",
  "tin": "string",
  "address": {
    "city": "Lorem",
    "state": "KY",
    "address1": "address1 ",
    "country": "BO",
    "postalCode": "Lorem",
    "isoCountryCode": "US"
  },
  "lat_long": {
    "lat_long_data": "Lorem",
    "lat_long_country": "US",
    "lat_long_city": "address1 "
  },
  "tax": {
    "country": "BO",
    "idNumber": "122-22-2332",
    "state": "string"
  },
  "governmentDocuments": [
    {
      "description": "national id card of user",
      "fileName": "idCard.png",
      "side": "front",
      "type": "DriversLicense",
      "content": "string",
      "number": "123455",
      "issuedCountry": "INDIA",
      "expired": false,
      "validFromDate": "2012-12-12",
      "validTillDate": "2012-02-02"
    }
  ],
  "proofOfAddress": [
    {
      "description": "credit card statement for Sep2024",
      "fileName": "cc1.png",
      "side": "front",
      "type": "front",
      "content": "string",
      "number": "123455",
      "issuedCountry": "INDIA",
      "expired": false,
      "validFromDate": "2012-12-12",
      "validTillDate": "2012-02-02"
    }
  ],
  "passport": {
    "description": "national id card of user",
    "fileName": "idCard.png",
    "side": "front",
    "type": "DriversLicense",
    "content": "string",
    "number": "123455",
    "issuedCountry": "INDIA",
    "expired": false,
    "validFromDate": "2012-12-12",
    "validTillDate": "2012-02-02"
  },
  "others": {
    "stateIdLicense": "321",
    "proofOfAddress": "321",
    "alienIdCard": "321"
  },
  "selfieContent": "string",
  "metroLocationDetails": {
    "shortName": "San Francisco",
    "fullName": "San Francisco, California",
    "code": "USA-SFO"
  },
  "additionalLatLong": {
    "lat": "37.8888888",
    "long": "-122.1777777"
  },
  "additionalAddress": {
    "fullName": "United States of America",
    "nameISO3": "USA"
  },
  "geoLocationDetails": {
    "declaredAddress": "San Francisco",
    "phoneNumber": "+91-9876676556",
    "iPAddress": "127.0.0.1"
  },
  "metroAreaDetails": {
    "deviceData": "example",
    "declaredAddress": "San Francisco, California",
    "phoneNumber": "+91-987765566",
    "iPAddress": "127.0.0.1"
  },
  "countryDetails": {
    "deviceData": "example",
    "declaredAddress": "San Francisco, California",
    "phoneNumber": "+91-9876665654",
    "iPAddress": "127.0.0.1"
  },
  "verifiedName": "string",
  "verifiedDOB": "2012-12-12",
  "verifiedPhoto": "string",
  "verifiedIDNumber": "string",
  "verifiedCountry": "string",
  "verifiedState": "string",
  "verifiedIDIssueDate": "2012-12-12",
  "verifiedIDExpirationDate": "2012-12-12",
  "verifiedAddress": {
    "fullAddress": "Lorem Ipsum 30, 13612 Tallinn, Estonia"
  },
  "verifiedGender": "string",
  "bankAccountDetails": {
    "bankLegalName": "US Bank",
    "bankAccountHolderName": "John Doe",
    "bankAccountType": "Savings",
    "bankAccountNumber": "Ul22440412",
    "bankAccountHolderPhoneNumber": "+917347634906",
    "bankAccountHolderEmail": "unknown@gmail.com",
    "bankAccountHolderAddress": "Lorem Ipsum 30, 13612 Tallinn, Estonia"
  },
  "plaidDetails": {
    "plaidToken": "token",
    "plaidConsentTimestamp": "2024-09-25T10:51:39.1788210+00:00"
  }
}

Response Examples

Code	Description
201	Created response after tenant customer successfully onboard
400	Error response after tenant customer onboarding gets failed

201 — Created response after tenant customer successfully onboard

{
  "data": {
    "firstName": "Jone",
    "middleName": "string",
    "lastName": "Doe",
    "accountAddress": "string",
    "tenantId": "e1e9adb4-d3bd-4ba5-98b8-011c03a9d2b1",
    "dateOfBirth": "1997-02-02",
    "email": "lorem@mygmail.com",
    "gender": "male",
    "phoneNumber": "123455656789",
    "address": {
      "city": "Lorem",
      "state": "KY",
      "address1": "address1 ",
      "country": "BO",
      "postalCode": "Lorem",
      "isoCountryCode": "US"
    },
    "tax": {
      "country": "BO",
      "idNumber": "122-22-2332",
      "state": "string"
    },
    "documents": [
      {
        "description": "national id card of user",
        "fileName": "idCard.png",
        "side": "front",
        "type": "DriversLicense",
        "content": "string",
        "number": "123455",
        "issuedCountry": "INDIA",
        "expired": false,
        "validFromDate": "2012-12-12",
        "validTillDate": "2012-02-02"
      }
    ],
    "faceImage": "string",
    "complianceStatus": "PENDING",
    "customerAccountId": "11167c62-b6b4-4031-ac92-6ef56e9648bd",
    "customerAccountCategory": "Bronzeone",
    "assignedIdentificationBadge": "11167c62-b6b4-4031-ac92-6ef56e9648bd",
    "domainNamespace": "allahabad.amitp.ul"
  },
  "message": "User has successfully onboarded with the badge Bronzeone [8d16684e-ee0a-4c10-83c0-c4d89e6a8666]."
}

400 — Error response after tenant customer onboarding gets failed

{
  "errors": [
    {
      "type": "catch",
      "message": "Please provide valid tenant id"
    },
    {
      "type": "Onboard Customer",
      "message": "Please provide a valid ISO 3166-1 alpha-2 country and state code"
    },
    {
      "type": "Onboard Customer",
      "message": "Custom namespace is taken"
    },
    {
      "type": "Duplicate",
      "message": "Account address already taken"
    },
    {
      "type": "Tenant",
      "message": "Tenant's account has been blocked. You will be not able to onboard any user. Please get in touch with support team"
    },
    {
      "type": "Duplicate",
      "message": "No data found with given tenant Id"
    },
    {
      "type": "Tenant",
      "message": "Tenant onboarding status is isTenantAvailableCheck?.onboardingStatus"
    },
    {
      "type": "onboard",
      "message": "A user is already been registered with provided email id"
    },
    {
      "type": "onboard",
      "message": "Wallet user already exists inside tenant"
    },
    {
      "message": "There are no sufficient documents",
      "type": "Documents"
    },
    {
      "message": "A user is already been registered with provided email id",
      "type": "Duplicate"
    },
    {
      "type": "Finclusive",
      "message": "messages"
    },
    {
      "type": "catch",
      "message": "err[1]"
    },
    {
      "type": "catch",
      "message": "error.message"
    },
    {
      "type": "Identity",
      "message": "error in deleting identity"
    },
    {
      "type": "Rule Error",
      "errors": "axiosResponse.errors"
    },
    {
      "type": "Duplicate",
      "message": "Blockchain address already exists on the platform, onboarding not permitted.",
      "error_code": "ULOT0043"
    },
    {
      "type": "Duplicate",
      "message": "UNS ID (Custom namespace) already exists on the platform, onboarding not permitted.",
      "error_code": "ULOT0044"
    },
    {
      "type": "Duplicate",
      "message": "Customer has already been onboarded based on unique identification parameters.",
      "error_code": "ULOT0045"
    },
    {
      "type": "Customer",
      "message": "Missing [first name and last name or full name] Unique Identification parameters in the onboarding request.",
      "error_code": "ULOT0046"
    },
    {
      "type": "Customer",
      "message": "Unable to allocate badge to wallet user for onboarding request.",
      "error_code": "ULOT0047",
      "denial_code": "l07",
      "denial_reason": "Invalid email address"
    }
  ]
}

🚫 Deprecated Endpoints

Deprecated in this version

GET /reconcile — fetch reconciliation logs
POST /reconcile — reconcile transactions
POST /tenant/customer/api/otp/request — Request otp for customer email verification
POST /tenant/customer/api/otp/verify — Verify otp for customer email verification

Partner API — v2.8.0

✅ New Endpoints

GET /cards/details

Query Parameters

Response Codes

GET /cards/eligible-cards

Query Parameters

Response Codes

GET /federate-id/file-upload-status

Query Parameters

Response Codes

GET /federate-id/linked

Query Parameters

Response Codes

PATCH /cards/block-unblock

Request Body

Response Codes

POST /cards/report/lost

Request Body

Response Codes

POST /cards/report/stolen

Request Body

Response Codes

POST /cards/request-card

Request Body

Response Codes

POST /federate-id/file-upload

Request Body

Response Codes

POST /federate-id/link

Request Body

Response Codes

POST /transaction/confirmation-requests

Request Body

Response Codes

POST /transaction/deposit-requests

Request Body

Response Codes

POST /transaction/exchange-plaid-token

Request Body

Response Codes

POST /transaction/plaid-link-token

Request Body

Response Codes

✏️ Modified Endpoints

POST /tenant/customer

Updated Request Body Fields

Current Request Example

Response Examples

🚫 Deprecated Endpoints

GET `/cards/details`

GET `/cards/eligible-cards`

GET `/federate-id/file-upload-status`

GET `/federate-id/linked`

PATCH `/cards/block-unblock`

POST `/cards/report/lost`

POST `/cards/report/stolen`

POST `/cards/request-card`

POST `/federate-id/file-upload`

POST `/federate-id/link`

POST `/transaction/confirmation-requests`

POST `/transaction/deposit-requests`

POST `/transaction/exchange-plaid-token`

POST `/transaction/plaid-link-token`

POST `/tenant/customer`