KAkalixa

Uploads a new document.

Uploads a new document.

post/documents

Request

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

Request body multipart/form-data

contentstring binary required

Contains the document (file) content base64 encoded to be uploaded. Used for screening purposes by the PXP Financial Risk Team.

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

The type of the document to be uploaded. Used for validation and screening purposes by the PXP Financial Risk Team.

namestring required

The file name (including the file extension) of the document to be uploaded. Used for association and filtering.

merchantIdstring

The id of the merchant to which this document belongs/relates to. Used for association and filtering.

shopIdstring

The id of the shop to which this document belongs/relates to. Used for association and filtering.

relatedPersonIdstring

The id of the person to which this document belongs/relates to. Used for association and filtering.

relatedCompanyIdstring

The id of the company to which this document belongs/relates to. Used for association and filtering.

bankAccountIdstring

The id of the bank account to which this document belongs/relates to. Used for association and filtering.

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.