GIDX: DocumentLibrary

Home / API Reference
Code Samples Coming Soon... C# PHP Python

API Integration: DocumentLibrary

Introduction & Document Overview

This is a documentation for the DocumentLibrary API, a service within the Customer Insight Solution set of the GIDX Platform.

This set of documents serves as the integration guide for implementing services of the GIDX Platform API within the operator’s environment. The following pages outline the Customer Insight access points, security, methods, and parameters. As always, please contact us at devteam@tsevo.com any time if further explanation is needed.

API libraries

An official SDK for the GIDX Platform API is available at GitHub.com and via NuGet (GIDX.SDK) located at the URL below. This SDK can be installed directly into your C# project using the NuGet Package Manager.

SDK Location
https://github.com/TSEVOLLC/GIDX.SDK-csharp

GIDX Platform DocumentLibrary API Method Reference

Below are descriptions of the methods exposed by the GIDX Platform DocumentLibrary Service. For details about the parameters associated with these methods please see the Class Reference section below.

https://api.gidx-service.in/v3.0/api/DocumentLibrary
https://api.gidx-service.in/v3.0/api/DocumentLibrary
https://api.gidx-service.in/v3.0/api/DocumentLibrary

DocumentLibrary: Request & Response Parameter Constants

The following parameters are used in every DocumentLibrary Method Request and Responses. They are labeled within the methods below as Standardized Request Parameters and Standardized Response Parameters.

Making a Request
Each API method has a corresponding Request object used to transport the request parameters as shown below.

Using the Response
Each Response object returned from the method Request will contain properties you can use to determine the status of the methods service. Use the IsSuccess property along with the ResponseCode and ResponseMessage values to detect if the Request completed without a problem.

Standardized Request Parameters

ApiKey
String Required
Your assigned ApiKey, provided to you by the GIDX team.
4QhgWWJxRlqVctrc7SxHEQ
MerchantID
String Required
Your assigned Merchant ID, provided to you by the GIDX team.
VpGYLoXhSS+WgU9N415IJQ
ProductTypeID
String Required
Your assigned ID for merchant product type.
Fc+k5kRDSAOrh38e21vt0w
DeviceTypeID
String Required
Your assigned ID for this specific customer device type.
m+2XHlcIR0O1C+iBeNzfvA
ActivityTypeID
String Required
Your assigned ID for this specific customer activity type.
VV4XTc3tRi6g1EYLOazn0g
MerchantSessionID
String Required
A unique SessionID from your system assigned to this active session.
xHhSS+WglqVctrc7-t7SEQrc

Standardized Response Parameters

ApiKey
String Echo
Echo of your assigned ApiKey that you provided in the request.
4QhgWWJxRlqVctrc7SxHEQ
MerchantID
String Echo
Echo of your assigned Merchant ID that you provided in the request.
VpGYLoXhSS+WgU9N415IJQ
MerchantSessionID
String Echo
Echo of your unique SessionID for this active session that you provided in the request.
xHhSS+WglqVctrc7-t7SEQrc
ResponseCode
Integer
Response code for the method call. This will be 0 if there are no issues, non-zero otherwise.
0
ResponseMessage
String
Readable text message corresponding to the response code.
No Errors
https://api.gidx-service.in/v3.0/api/DocumentLibrary
https://api.gidx-service.in/v3.0/api/DocumentLibrary

Identity: DocumentRegistration

This method may be called to register (upload) a document to a customer profile within the GIDX Platform.

Request Type:
HTTP POST: JSON
Parameters:
DocumentRegistrationRequest (object)
Return Value:
DocumentRegistrationResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/DocumentLibrary/DocumentRegistration

Note: In the HTTP post to the DocumentRegistration endpoint, the Content-Type header should be set to multipart/form-data. The request should have 2 form-data parts in the body:

json:
The DocumentRegistrationRequest serialized as JSON
file:
The file contents

DocumentRegistrationRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
MerchantCustomerID
String Required
Your unique ID for this customer.
ABC-123
CategoryType
Int
Required - The category that best describes the type of document that is being uploaded.
See CategoryType Listing
DocumentStatus
Int
Required - The current status of the document that is being uploaded.
See DocuemntStatus Listing
File
Stream Required
For more information visit W3 Schools.

DocumentRegistrationResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
MerchantCustomerID
String Echo
Echo of your unique ID for this customer.
ABC-123
Document
Object
Object containing the attributes of the file.
See object referenece
https://api.gidx-service.in/v3.0/api/DocumentLibrary
https://api.gidx-service.in/v3.0/api/DocumentLibrary

Identity: CustomerDocuments

This method may be called to receive a list of documents registered within a customer's document library within the Platform.

Request Type:
HTTP GET: Query String
Parameters:
CustomerDocumentsRequest (object)
Return Value:
CustomerDocumentsResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/DocumentLibrary/CustomerDocuments

CustomerProfileRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
MerchantCustomerID
String Required
Your unique ID for this customer.
ABC-123

CustomerProfileResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
MerchantCustomerID
String Echo
Echo of your unique ID for this customer.
ABC-123
DocumentCount
Int
The number of files within this customers library.
6
Documents
Object

Identity: DownloadDocument

This method may be called to get the current compliance status of the customer profile associated with a verified MerchantCustomerID within the GIDX system.

Request Type:
HTTP GET: Query String
Parameters:
DownloadDocumentRequest (object)
Return Value:
DownloadDocumentResponse (object)
Endpoint URL:
https://api.gidx-service.in/v3.0/api/DocumentLibrary/DownloadDocument

DownloadDocumentRequest

Standardized Parameters
Standard Request
See the Standardized Paramaters above.
DocumentID
String Required
Your unique ID for this document.
456-ABC-123

DownloadDocumentResponse

Standardized Parameters
Standard Response
See the Standardized Paramaters above.
DocumentID
String Echo
Echo of your unique ID for this document.
456-ABC-123

Note: The format of the response for this endpoint depends on its success:

If successful:
The HTTP response will have a Content-Disposition header value of "attachment" with the file contents in the body.
If failed:
The HTTP response will be the DownloadDocumentResponse   serialized as json.

Response Object Reference

The Object documented below are returned within the Response of Method Request within the GIDX Platform DocumentLibrary Services. When applicable an Object may be shared by among other Method Responses as indicated in the listings below.

Objects are always returned in JSON format.

Profile Object: Document

This object contains the Document information provided within the DocumentRegistration Response.

Returned in Response:
DocumentRegistrationResponse
Usage:
The results contained in this object will provide you the data parameters that were saved to the uploaded document.
Property Name
Description / Data Type
Example
DocumentID
String
Your unique ID for this document.
456-ABC-123
CategoryType
Int
The category that best describes the type of document that is being uploaded.
See CategoryType Listing
DocumentStatus
Int
The current status of the document that is being uploaded.
See DocuemntStatus Listing
FileName
String
Name of the original file that was uploaded.
DriversLicenseTexas.jpg
FileSize
int
The physical size of the original file in bytes.
1025698
DateTime
UTC DateTime
The Date & Time that the file was uploaded.
YYYY-MM-DD hh:mm:ss tt
DocumentNotes
Object
Array of the DocumentNote object contains a list of arrays of the notes for this document.
See object reference

Profile Object: DocumentNote

This object contains a list of arrays for the Document Note information.

Returned in Object:
Document
Usage:
The results contained in this object will provide you the DocumentNote information that were applied to the document.
Property Name
Description / Data Type
Example
AuthorName
String
Name of the person that created the note.
Kent Mansley
NoteText
String
The test of the note. Max length of 1000 characters.
This is a note.
DateTime
UTC DateTime
The Date & Time that the note was created.
YYYY-MM-DD hh:mm:ss tt

Appendix Library: Code / Status Index

The information documented below provides clarification of the codes used within the GIDX Platform DocumentLibrary Services.

Appendix Library: Response Codes & Messages

Code
Message / Description
0
Good - Successful Response
500
General Error - Unknown Response Error
501
Invalid Request - Incorrect Request Format or Access Status
502
Unauthorized Request - Security Block of Request
600
Document Category is Invalid.
601
Document Status is Invalid.
602
File is over the size limit.
603
File extension invalid or missing.

Appendix Library: DocumentStatus

Code
Description / Source
1
Not Reviewed
The document has not been reviewed for validation.
2
Under Review
The document is currently under reveiw for validation.
3
Review Complete
The document review process is complete.
This does not automatically mean that the document was validated, only that the reveiw process has been marked as complete.

Appendix Library: CategoryTypes

Code
Description / Source
1
Other
2
Drivers License
3
Passport
4
Military ID
5
Govt. Issued Photo ID
6
Student Photo ID
7
Utility Bill

Appendix Library: Data & System Reference

ISO 2 Digit Country Code

ISO 3166-1 is part of the ISO 3166 standard published by the International Organization for Standardization (ISO), and defines codes for the names of countries, dependent territories, and special areas of geographical interest.
http://en.wikipedia.org/wiki/ISO_3166-1

ISO 2 Digit U.S. State Codes

ISO 3166-2:US is the entry for the United States in ISO 3166-2, part of the ISO 3166 standard published by the International Organization for Standardization (ISO), which defines codes for the names of the principal subdivisions (e.g., provinces or states) of all countries coded in ISO 3166-1.
http://en.wikipedia.org/wiki/ISO_3166-2:US

ReasonCodes

For the latest list of Reason Codes and their description please go to the following URL.
View Reason Codes