com.mangopay.core.APIs

Interface KycDocumentApi

All Known Implementing Classes:

KycDocumentApiImpl

public interface KycDocumentApi

Created by thepa on 18-Jan-17.

Method Summary

Modifier and Type	Method and Description
java.util.List<DocumentPageConsult>	createKycDocumentConsult(java.lang.String kycDocumentId) Creates temporary URLs where each page of a KYC document can be viewed.
java.util.List<KycDocument>	getAll(Pagination pagination, Sorting sorting) Gets all KYC documents.
KycDocument	getKycDocument(java.lang.String kycDocumentId) Gets KYC document.

Method Detail

getAll

java.util.List<KycDocument> getAll(Pagination pagination,
                                   Sorting sorting)
                            throws java.lang.Exception

Gets all KYC documents.

Parameters:

pagination - Pagination object.

sorting - Sorting object.

Returns:

Collection of KycDocuments returned from API.

Throws:

java.lang.Exception

getKycDocument

KycDocument getKycDocument(java.lang.String kycDocumentId)
                    throws java.lang.Exception

Gets KYC document.

Parameters:

kycDocumentId - KYC document identifier.

Returns:

KYC document returned from API.

Throws:

java.lang.Exception

createKycDocumentConsult

java.util.List<DocumentPageConsult> createKycDocumentConsult(java.lang.String kycDocumentId)
                                                      throws java.lang.Exception

Creates temporary URLs where each page of a KYC document can be viewed.

Parameters:

kycDocumentId - Identification of the document whose pages to view

Throws:

java.lang.Exception