Upload Agent Identity Image

PUT 
/users/:agent_id/identities

This is an endpoint for uploading the created Agent’s identity image. The identity image will be used by Flip for verifiying the agent data.

Request

Path Parameters

agent_id stringrequired

The ID of the agent

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_type stringrequired

The value should be 1 (user type Agent)

image binaryrequired
Image file that wants to be uploaded.
Validation:
1. Size less than 2MB
2. Dimension between 256 (W) x 256 (H) and 4096 (W) x 4096 (H)
3. File type should be png, jpg, or jpeg
4. Image should be uploaded right from Camera app (not Gallery or File or Document app)
identity_type stringrequired

Type of identity. Accepted values "1" National Id Card or KTP in Indonesia "2" Passport

selfie string

Flag denotes the uploaded file is the identity image or selfie with identity image. Validation, accepted value are as follows: - 0: False (default). Denotes that the uploaded file is identity image. - 1: True. Denotes that the uploaded file is selfie with identity image.

Responses

200

Successful response

application/json

Schema

Schema

image_url uri

Example (from schema)

{
  "image_url": "someurl.png"
}

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...