Get Agent Identity

GET 
/v2/agents/:agent_id

An endpoint for obtaining the Agent identity data.

Request

Path Parameters

agent_id stringrequired

Flip’s Agent id

Responses

200

Expected Response

application/json; charset=UTF-8

Schema

Schema

id integer
company_id integer
name string
identity_type string
identity_number string
phone_number string
email string
kyc_status string
rejected_reason_code string
rejected_reason string
status string
created_at string

Example (from schema)

{
  "id": 1,
  "company_id": 20,
  "name": "John Doe",
  "identity_type": "ktp",
  "identity_number": "1234567890123456",
  "phone_number": "+628123456789",
  "email": "example@mail.com",
  "kyc_status": "APPROVED",
  "rejected_reason_code": null,
  "rejected_reason": "",
  "status": "ACTIVE",
  "created_at": "2022-01-01 13:00:00"
}

401

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

application/json; charset=UTF-8

Schema

Schema

name string
message string
status integer

Example (from schema)

{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "status": 401
}

404

Response when you put invalid agent id

application/json; charset=UTF-8

Schema

Schema

name string
message string
status integer

Example (from schema)

{
  "name": "Not Found",
  "message": "Agent not found",
  "status": 404
}

Loading...