lighthouse

Retrieves a Merchant's Document by ID

Retrieves a Merchant's Document by ID

get/lighthouse/v1/documents/{documentId}

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/lighthouse/v1/documents/{documentId}
  • Auth: OAuth 2 (implicit, authorization URL "")

Path parameters

documentIdstring required

documentId

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Response

success

createdAtstring
fileTypestring
idstring
namestring
originalFileNamestring
rejectReasonstring
sizeinteger
type'OTHERS' | 'PC_COMPANY_AFFIDAVIT' | 'PC_SHAREHOLDERS_LIST' | 'PC_VAT_CERTIFICATE' | 'PI_ID_CARD' | 'PI_HOUSE_REGISTRATION' | 'PI_COMMERCIAL_REGISTRATION_CERT' | 'PI_PROOF_OF_WEB_OWNERSHIP' | 'PI_SELFIE'
verificationStatus'UNVERIFIED' | 'VERIFIED' | 'REJECTED'

Changes

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