Get Sandbox Access

Paybase Developer Centre

OverviewAPI GuidesGetting StartedRecipesGig Economy PlatformsSharing Economy PlatformsMarketplacesBlockchain BusinessesEscrowSandboxRolesRulesDue DiligenceCustomersAccountsBank AccountsCardsTransactionsIntroductionInboundGetting money into the systemTransaction ReferenceAccount ReferenceInternalOutboundEscrowSplit PaymentsRefundsStrong Customer Authentication3D Secure AuthenticationIntroductionCreate a cardCreate a transactionDocument UploadStatementsWebhooksErrorsPQLAPI ReferenceAccountCreate an accountRetrieve an accountTransition account statusList all accountsAnnotate an accountDelete annotation from an accountTag an accountDelete tag from an accountBank AccountCreate a bank accountRetrieve a bank accountUpdate a bank accountTransition bank account statusList all bank accountsAnnotate a bank accountDelete annotation from a bank accountTag a bank accountDelete tag from a bank accountCardCreate a cardRetrieve a cardUpdate a cardTransition card statusList all cardsAnnotate a cardDelete annotation from a cardTag a cardDelete tag from a cardCardholderCreate a cardholderRetrieve a cardholderUpdate a cardholderTransition cardholder statusList all cardholdersAnnotate a cardholderDelete annotation from a cardholderTag a cardholderDelete tag from a cardholderCreate an authentication tokenCheckCreate a checkCustomerIndividual CustomerCreate a customerRetrieve a customerUpdate a customerSole TraderCreate a customerRetrieve a customerUpdate a customerOrganisationCreate a CustomerRetrieve a CustomerUpdate a CustomerIncorporated BusinessCreate a customerRetrieve a customerUpdate a customerBusiness PersonAdd a business personRetrieve a business personUpdate a business personDelete a business personRetrieve a customerTransition state of a customerList all customersAnnotate a customerDelete annotation from a customerTag a customerRemove tag from a customerCreate an authentication tokenTouch a customerDocumentCreate a documentRetrieve a documentList Document TypesReferenceRetrieve a referenceStatementRetrieve a statementStatusRetrieve API statusTransactionCreate inbound transactionCreate internal transactionCreate outbound transactionRetrieve a transactionTransition transaction statusList all transactionsAnnotate a transactionDelete annotation from a transactionTag a transactionDelete tag from a transaction
API version: a0406ac

Retrieve a documentGET/v1/document/{id}

1
2
3
4
5
6
7
import { v1 } from '@paybase/client';

const client = v1('<- API Key ->', { sandbox: true });

const result = await client.getDocument({
  id: "document/28958679-e8a8-47a8-967c-f979ae8509a2"
});

1
2
3
4
5
6
7
8
9
10
import json
import requests

requests.get(
  "https://api-json.sandbox.paybase.io/v1/document/document/28958679-e8a8-47a8-967c-f979ae8509a2Params: id",
  headers = {
    "Content-Type": "application/json",
    "X-Token": "<X-Token goes here>"
  }
).json()

1
2
3
4
5
6
7
8
9
10
11
$client = new \GuzzleHttp\Client();
$client->request(
  "get",
  "https://api-json.sandbox.paybase.io/v1/document/document/28958679-e8a8-47a8-967c-f979ae8509a2Params: id",
  [
    "headers" => [
      "Content-Type" => "application/json",
      "X-Token" => "<X-Token goes here>",
    ]
  ]
);

1
2
3
4
curl -X GET \
"https://api-json.sandbox.paybase.io/v1/document/document/28958679-e8a8-47a8-967c-f979ae8509a2Params: id"  -H "Content-Type: application/json" \
  -H "X-Token: <X-Token goes here>" \

Request

FieldDescription
idURI Param
string

The unique identifier of the entity.

Format

_entity_/_uuid_

e.g. customer/62dc1d23-d473-46a6-b4b3-e63c3f6d4658 or account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

Response

FieldDescription
id
string

The unique identifier of the document object.

createdAt
date

The timestamp in UTC at which the document object was created.

updatedAt
date

The timestamp in UTC at which the document object was last updated.

stateId
enum

The state of the Document.

enum

PENDING, VALID, INVALID

customerId
string

The unique identifier of the customer with which the document is associated.

Format

customer/_uuid_

e.g. customer/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

type.type
enum

The type of the uploaded document.

enum

ID_DOCUMENT, ADDRESS_VERIFICATION, PURPOSE_OF_ACCOUNT, OCCUPATION, SOURCE_OF_WEALTH, SOURCE_OF_FUNDS, OTHER, ADDITIONAL_INFORMATION, ADDITIONAL_INFORMATION_VERIFICATION, BUSINESS_PURPOSE, INDUSTRY, COMPLIANCE

type.subtype
string

The subtype of the uploaded documentation. Possible values depend on the type of document.

e.g. When uploading a document of type ID_DOCUMENT, the subtype could be Driver's License

fileName
string

The document file name.

tags
array<string>

An array of string values. Tags can be attached to objects in order to drive rules based logic either on Paybase or on your own system.

annotations
object<string, string>

A hash map of key value pairs. Annotations allow you to supply information which is pertinent to your own system (e.g. Providing the ID of a customer on your system to link to their Paybase account). Annotations can also drive various Paybase rules.