Underwriting APIs

SFTP - Portfolio Review - Generate Request

Introduction
This api allows the user to provide the input path to their SFTP which contains input files. These files will be fetched and processed and uploaded to the output folder path of their SFTP. 
Please contact Signzy Support in order to add your SFTP Configuration to use this API.
cURL
Production
Pre-Production
curl --location 'https://api.signzy.app/api/v3/bureau/portfolio-review-generate-request' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "filePath" : "/client/inputFolder",
    "product" : ["crif", "equifax"]
}'
curl --location 'https://api.signzy.app/api/v3/bureau/portfolio-review-generate-request' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
    "filePath" : "/client/inputFolder",
    "product" : ["crif", "equifax"]
}'
﻿
Request Headers
Key
Value
Authorization
Shared by Signzy
Content-type
application/json
Request Body
JSON
{
    "filePath" : "/client/inputFolder",
    "product" : ["crif", "equifax"]
}
{
    "filePath" : "/client/inputFolder",
    "product" : ["crif", "equifax"]
}
﻿
PARAMETERS
DESCRIPTION
TYPE
VALUE (COMPULSORY OR OPTIONAL)
filePath
The path to the folder containing the input files
String
COMPULSORY
products 
The products which the client want to use
Array of Strings
COMPULSORY
Response Data
JSON
{
    "statusCode": 200,
    "statusMessage": "success",
    "fileStatus": "RECEIVED",
    "requestId": {
        "86264289-d977-4875-9429-139eca7708c4": "/client/inputFolder/SFTP_Testing_Data3.csv",
        "f8668fa2-c353-4a6a-86f8-76dc8f062238": "/client/inputFolder/SFTP_Testing_Data2.csv",
        "071e5ec0-bcd5-43ad-a29c-320f28de4461": "/client/inputFolder/SFTP_Testing_Data1.csv"
    }
}
{
    "statusCode": 200,
    "statusMessage": "success",
    "fileStatus": "RECEIVED",
    "requestId": {
        "86264289-d977-4875-9429-139eca7708c4": "/client/inputFolder/SFTP_Testing_Data3.csv",
        "f8668fa2-c353-4a6a-86f8-76dc8f062238": "/client/inputFolder/SFTP_Testing_Data2.csv",
        "071e5ec0-bcd5-43ad-a29c-320f28de4461": "/client/inputFolder/SFTP_Testing_Data1.csv"
    }
}
﻿
PARAMETERS
DESCRIPTION
TYPE
requestId
Object containing the requestIds for each file present in the input folder that is being processed. It contains the request ID to input file path mapping
Object
fileStatus
Indicates the status of the files. "RECEIVED" - The files were successfully received from the client SFTP
String
statusCode
﻿
The statusCode of the request
Number
statusMessage
Indicates whether the status of the request was successful
String
Status Codes
200 OK
400
400
401
500
{
    "error": {
        "name": "error",
        "message": "Internal Server Error",
        "status": 500,
        "reason": "ERROR",
        "type": "Internal Server Error",
        "statusCode": 500
    }
}
{
    "error": {
        "name": "error",
        "message": "Internal Server Error",
        "status": 500,
        "reason": "ERROR",
        "type": "Internal Server Error",
        "statusCode": 500
    }
}
﻿
﻿
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].
﻿

GST Certificate Download

What is the AA Framework?

Docs powered by Archbee

TABLE OF CONTENTS

Key	Value
Authorization	Shared by Signzy
Content-type	application/json

PARAMETERS	DESCRIPTION	TYPE	VALUE (COMPULSORY OR OPTIONAL)
filePath	The path to the folder containing the input files	String	COMPULSORY
products	The products which the client want to use	Array of Strings	COMPULSORY