KAkalixa

Returns a single document's data.

Returns a single document's data.

get/documents/{documentId}

Request

  • Base URL
    https://api.test.kalixa.com/payment-service/v6
  • URL
    https://api.test.kalixa.com/payment-service/v6/documents/{documentId}
  • Auth
    HTTP basic

Path parameters

documentIdstring required

The id of the document which should be returned.

Response

Successful operation

idstring

The server-generated id of the document which was uploaded/returned.

namestring

The name of the document (file).

type'AddressProofForMerchantLocation' | 'AnnualReport' | 'ArticlesOfAssociation' | 'BankReferenceLetter' | 'BankStatement' | 'BusinessLicenseOrAuthorization' | 'CardProcessingHistory6Months' | 'CertificationOfIncorporation' | 'ChargebackAndFraudPolicyAndProcedures' | 'CompanyAMLPolicyAndGuidelines' | 'Contract' | 'LegalOpinion' | 'ExternalRiskChecksResult' | 'ExternalCompanyRiskChecksResult' | 'ExternalCustomerRiskChecksResult' | 'Organogram' | 'PassportOrGovernmentID' | 'PCIQuarterlyASVReport' | 'PCIReportOnCompliance' | 'PCISelfAssessmentQuestionnaire' | 'PersonalUtilityBill' | 'ProofOfAuthorisedSignatory' | 'ProofOfDomainOwnership' | 'TaxFilings'

The type of the document (file).

Example response

{
  "id": "8a527b13-01d6-49e1-92d6-98a8ea58076e",
  "name": "Passport.pdf",
  "merchant": {
    "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
  },
  "shop": {
    "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
  },
  "bankAccount": {
    "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
  },
  "relatedPerson": {
    "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
  },
  "relatedCompany": {
    "id": "f6b4d04e-1a67-4f7b-a6b0-181636af3290"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.