Upload KYC Documents

POST 
/documents

This is an endpoint for uploading supporting documents other than the identity image. Supporting documents could be passport, student card, employee card, driving license, etc. At least 1 image should be sent via this API. Image validations are as follows:

• Size less than 2MB
• Dimension between 256 (W) x 256 (H) and 4096 (W) x 4096 (H)
• File type should be png, jpg, or jpeg
• Image should be uploaded right from Camera app (not Gallery or File or Document app)

Request

Header Parameters

Request-ID stringrequired

A unique identifier for the request, used for tracking and troubleshooting purposes. In case of any errors, Flip can use this value to trace and investigate the specific request. The Request-ID will be formed of bigflip-{uuid}, where the “uuid” (Universally unique identifier) has to be generated on your end. Example: "Request-ID: bigflip-47EB7F57-5565-4BF0-B9DD-46C6268CEE71".

multipart/form-data

Body

required

user_id stringrequired

The ID of the user Agent, the value should be numeric

user_type integerrequired

The type of user for Agent, the value is 1

student_card binary

The student's card image file.

student_card_selfie binary

A selfie with the student's card.

employee_card binary

The employee's card image file.

employee_card_selfie binary

A selfie with the employee's card.

last_certificate binary

The last educational certificate image file.

last_certificate_selfie binary

A selfie with the last educational certificate.

passport binary

The passport image file.

passport_selfie binary

A selfie with the passport.

family_card binary

The family card image file.

family_card_selfie binary

A selfie with the family card.

driving_license binary

The driving license image file.

driving_license_selfie binary

A selfie with the driving license.

Responses

200

Successful upload

application/json

Schema

Schema

• Array [

id integer

The ID of the uploaded document.

type integer

The type of the document.

selfie boolean

Indicates if the document is a selfie.

path string

The URL path to the uploaded document.

created_at date-time

The timestamp when the document was created.

updated_at date-time

The timestamp when the document was last updated.

• ]

Example (from schema)

[
  {
    "id": 1,
    "type": 1,
    "selfie": false,
    "path": "some/path/url/image.png",
    "created_at": "2022-01-02T15:38:49.317601182+07:00",
    "updated_at": "2022-01-02T15:38:49.317601182+07:00"
  }
]

401

Sample response when Your Flip api secret key value for Authorization is missing or invalid

application/json

Schema

Schema

errors

object[]

Array [

code integer

message string

]

Example (from schema)

{
  "errors": [
    {
      "code": 401,
      "message": "Invalid Auth"
    }
  ]
}

Loading...