Manage File

Manage File

The Manage File API allows managing files for different entities (as CH, Org, etc). API options are: Add, Delete, View, UpdateFileContent, GetList The GetList option return two lists:

• The cardholder is sometimes required to provide specific files for verification and for non verification purposes. This list, under the "RequiredFiles" tag , design the file content types which can be uploaded for this cardholder.

• The ManageFile/Add API allows to upload file to a cardholder. This list, under the "UploadedFiles" tag, design the uploaded files.

Input Parameters:

Name	Required	Definition	Comments
Binary_File	C	Format: Binary	required only for OperationType=Add
Description	N	Format: 1-500, supported characters: Blank a-z A-Z 0-9 . , # $ ( ) / : ? - % + *	& ; @ ! ~ = _ \ '	relevant only for OperationType=Add
ID	Y	Format: Numeric, 1-19
ID	Y	Description Input should be OGR_ID in case IDType = ORG Input should be Order ID in case IDType = Order Input should be Card Number in case IDType = CH-CardNumber Input should be RPID in case IDType = CH-RPID
IDType	N	Format: ORG (Default) - require Org ID in ID field CH-RPID - require RPID in ID field CH-CardNumber - require Card Number in ID field\Order – require Order ID in ID field
Name	C	Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! ~ = _ '	Required for OperationType=Add, Delete, View, UpdateFileContent
OperationType	Y	Format options: Add Delete View UpdateFileContent GetList	Description: Add - Allow to add a new file to an organization/cardholder. Delete - Allow to delete a file View - Allow to download a file UpdateFileContent - Allow to change the file content of an existing document GetList - Get list of files for ID (sorted first by group and then by category, in ascending alphabetic order)
Content	C		Format options: The FileContent can be any value (allowed per Product Type). For example, It can be one of the following values (or other content types as well for each customer, based on his requirements): Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license, Pay Stub, School/Work ID, Tax Payer ID, Utility Bill, Third Party The supported characters are: a-z A-Z 0-9 _- / . ' ( ) It is limited to 100 characters

Output Parameters:

Name	Definition	Failure Case	Success Case	Comments
Binary_File	Format: Binary	Not returned	Returned	relevant only for OperationType=View
Category	Format Options: Primary Secondary Other Description: Primary files are the following file content types: Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license Secondary files are the following file content types: Pay Stub, School/Work ID, Tax Payer ID, Utility Bill, Other files refer to all other file content types (as Third Party)	Not returned	Returned	relevant only for OperationType=GetList. part of tag UploadedFiles and part of tag RequiredFiles
CHState	Format options: NRNV RNV V-PNS V	Not returned	Returned	relevant only for OperationType=GetList
Content	Format options: The FileContent can be any value (allowed per Product Type). For example, It can be one of the following values (or other content types as well for each customer, based on his requirements): Passport, Military ID, Matricula Consular, Permanent Resident ID, State-issued ID, US driver license, Pay Stub, School/Work ID, Tax Payer ID, Utility Bill, Third Party The supported characters are: a-z A-Z 0-9 _- / . ' ( ) It is limited to 100 characters	Not returned	Returned	relevant only for OperationType=GetList. part of tag UploadedFiles and part of tag RequiredFiles
Group	Format: 1-100	Not returned	Returned	relevant only for OperationType=GetList. part of tag UploadedFiles and part of tag RequiredFiles
Name	Format: 1-255, Supported characters: Blank a-z A-Z 0-9 . , # $ ( ) - + & ; @ ! ~ = _ '	Not returned	Returned	relevant only for OperationType=GetList. part of tag UploadedFiles
Type	Format: any supported type (as txt, jpg, doc, etc)	Not returned	Returned	relevant only for OperationType=GetList. part of tag UploadedFiles

XML Samples

Input XML

<?xml version="1.0" ?>
 <PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>st_manager</UserName>
        <UserPassword>st_manager</UserPassword>
      <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>;
    <ServiceDetails>
        <ServiceName>ManageFile</ServiceName>
        <UniqueRequestId>7532121212121213</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>praxell</OriginType>
    </Origin>
    <ServiceParams>
        <Binary_File>dGV4dCB0ZXN0</Binary_File>
        <Description>some description</Description>
        <ID>someOrgId</ID>
        <IDType>ORG</IDType>
        <Name>FileName.Ext</Name>
        <OperationType>Add</OperationType>
        <Content></Content>
    </ServiceParams>
 </PraxellXMLRequest>

<?xml version="1.0"?>
 <PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>ManageFile</ServiceName>
        <SessionId>38851911201245015</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2012-01-05 11:45:58</ServiceDate>
        <ServiceId>38851911201245015</ServiceId>
    </ResponseDetails>
   <ResponseParams>
   </ResponseParams>
 </PraxellXMLResponse>

<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>ManageFile</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70029</StatusCode>
    <StatusName>Data not found (cardholder not found)</StatusName>
    <StatusDescription>Data not found (cardholder not found)</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>