KYC

Server

Start KYC verification

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications

Start KYC verification › Request Body

level

string · enum

Enum values:

tier1

tier2

tier3

Start KYC verification › Responses

KYC verification started.

No data returned

My KYC history

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications/me

My KYC history › Responses

200

Verification list.

No data returned

Current KYC verification

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications/me/current

Current KYC verification › Responses

200

Current verification.

No data returned

KYC verification detail

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications/{id}

KYC verification detail › path Parameters

id

string · uuid · required

KYC verification detail › Responses

200

Verification detail.

No data returned

Submit a document to a KYC verification

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications/{id}/documents

Submit a document to a KYC verification › path Parameters

id

string · uuid · required

Submit a document to a KYC verification › Request Body

documentId

string · required

kind

string · required

Submit a document to a KYC verification › Responses

Document accepted.

No data returned

Cancel KYC verification

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications/{id}/cancel

Cancel KYC verification › path Parameters

id

string · uuid · required

Cancel KYC verification › Responses

200

Verification cancelled.

No data returned

Beneficiaries Documents

HeritagePay API

KYC

Server

Start KYC verification

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications

Start KYC verification › Request Body

level

string · enum

Enum values:

tier1

tier2

tier3

Start KYC verification › Responses

KYC verification started.

No data returned

My KYC history

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications/me

My KYC history › Responses

200

Verification list.

No data returned

Current KYC verification

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications/me/current

Current KYC verification › Responses

200

Current verification.

No data returned

KYC verification detail

GET

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications/{id}

KYC verification detail › path Parameters

id

string · uuid · required

KYC verification detail › Responses

200

Verification detail.

No data returned

Submit a document to a KYC verification

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications/{id}/documents

Submit a document to a KYC verification › path Parameters

id

string · uuid · required

Submit a document to a KYC verification › Request Body

documentId

string · required

kind

string · required

Submit a document to a KYC verification › Responses

Document accepted.

No data returned

Cancel KYC verification

POST

https://sandbox-heritagepay-api.paypm.net/api/v1

/kyc/verifications/{id}/cancel

Cancel KYC verification › path Parameters

id

string · uuid · required

Cancel KYC verification › Responses

200

Verification cancelled.

No data returned

Beneficiaries Documents