Create Agent Identity

POST 
/v2/agents

An endpoint to create company’s user (Agent) in Flip.

Request

Header Parameters

Content-Type stringrequired

Request content type application/x-www-form-urlencoded.

application/x-www-form-urlencoded

Body

required

name stringrequired

Agent’s full name.

identity_type stringrequired

Possible values: [ktp, passport]

Type of identity.

identity_number stringrequired

Identity number based on the type chosen.

birth_date stringrequired

Agent’s birth date. DD-MM-YYYY format

birth_place stringrequired

Agent’s birth place.

country_id stringrequired

Agent’s country code based on the identity chosen. Available values can be retrieved from the country list API here

province_id integerrequired

Agent’s province code based on the identity chosen. Available values can be retrieved from the province list API here.

city_id integerrequired

Agent’s city code based on the identity chosen. Available values can be retrieved from the city list API here.

district_id integerrequired

Agent’s district code based on the identity chosen. Available values can be retrieved from the district list API here.

address stringrequired

Agent’s address based on the identity chosen.

gender stringrequired

Possible values: [male, female]

Agent’s gender.

occupation stringrequired

Possible values: [housewife, entrepreneur, private_employee, government_employee, foundation_board, indonesian_migrant_worker, company, others]

Agent’s job.

phone_number stringrequired

Agent’s phone number. It must be the one that has been verified by the company.

use_identity_address integer

Possible values: [0, 1]

A flag to set if the current residential address of the Agent is the same as the identity address. 0 is false, 1 is true.

residence_country_id integer

Agent’s current residential address country code. Available values can be retrieved from the country list API here.

residence_province_id integer

Agent’s current residential address province code. Available values can be retrieved from the province list API here.

residence_city_id integer

Agent’s current residential address city code. Available values can be retrieved from the city list API here.

residence_district_id integer

Agent’s current residential address district code. Available values can be retrieved from the district list API here.

residence_address string

Agent’s current residential address.

email string

Agent’s email.

Responses

200

Expected Response

application/json; charset=UTF-8

Schema

Schema

id integer
company_id integer
name string
identity_type string

Possible values: [ktp, passport]

identity_number string
birth_place string
birth_date string
gender string

Possible values: [male, female]

country_id integer
country_name string
province_id integer
province_name string
city_id integer
city_name string
district_id integer
district_name string
address string
residence_country_id integer
residence_country_name string
residence_province_id integer
residence_province_name string
residence_city_id integer
residence_city_name string
residence_district_id integer
residence_district_name string
residence_address string
occupation string
phone_number string
email string
kyc_status string

Example (from schema)

{
  "id": 10,
  "company_id": 20,
  "name": "John Doe",
  "identity_type": "ktp",
  "identity_number": "1234567890123456",
  "birth_place": "Kota Depok",
  "birth_date": "31-10-1990",
  "gender": "male",
  "country_id": 1,
  "country_name": "Indonesia",
  "province_id": 12,
  "province_name": "Jawa Barat",
  "city_id": 12,
  "city_name": "Kota Depok",
  "district_id": 1234,
  "district_name": "Sukmajaya",
  "address": "Jalan Margonda Raya",
  "residence_country_id": 1,
  "residence_country_name": "Indonesia",
  "residence_province_id": 12,
  "residence_province_name": "Jawa Barat",
  "residence_city_id": 128,
  "residence_city_name": "Kota Depok",
  "residence_district_id": 1234,
  "residence_district_name": "Sukmajaya",
  "residence_address": "Jalan Margonda Raya",
  "occupation": "entrepreneur",
  "phone_number": "+628123456789",
  "email": "example@mail.com",
  "kyc_status": "BASIC_DATA"
}

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
}

422

Sample error response

application/json; charset=UTF-8

Schema

Schema

code string

errors

object[]

Array [

attribute string

code integer

message string

]

Example (from schema)

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "name",
      "code": 1001,
      "message": "name cannot be empty"
    }
  ]
}

Mising Required Fields

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "identity_type",
      "code": 1001,
      "message": "identity_type cannot be empty"
    },
    {
      "attribute": "identity_number",
      "code": 1001,
      "message": "identity_number cannot be empty"
    },
    {
      "attribute": "birth_place",
      "code": 1001,
      "message": "birth_place cannot be empty"
    },
    {
      "attribute": "country_id",
      "code": 1001,
      "message": "country_id cannot be empty"
    },
    {
      "attribute": "province_id",
      "code": 1001,
      "message": "province_id cannot be empty"
    },
    {
      "attribute": "city_id",
      "code": 1001,
      "message": "city_id cannot be empty"
    },
    {
      "attribute": "district_id",
      "code": 1001,
      "message": "district_id cannot be empty"
    },
    {
      "attribute": "address",
      "code": 1001,
      "message": "address cannot be empty"
    },
    {
      "attribute": "gender",
      "code": 1001,
      "message": "gender cannot be empty"
    },
    {
      "attribute": "occupation",
      "code": 1001,
      "message": "occupation cannot be empty"
    },
    {
      "attribute": "phone_number",
      "code": 1001,
      "message": "phone_number cannot be empty"
    }
  ]
}

Mising identity_type Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "identity_type",
      "code": 1001,
      "message": "identity_type cannot be empty"
    }
  ]
}

Mising identity_number Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "identity_number",
      "code": 1001,
      "message": "identity_number cannot be empty"
    }
  ]
}

Mising birth_place Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "birth_place",
      "code": 1001,
      "message": "birth_place cannot be empty"
    }
  ]
}

Mising country_id Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "country_id",
      "code": 1001,
      "message": "country_id cannot be empty"
    }
  ]
}

Mising province_id Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "province_id",
      "code": 1001,
      "message": "province_id cannot be empty"
    }
  ]
}

Mising city_id Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "city_id",
      "code": 1001,
      "message": "city_id cannot be empty"
    }
  ]
}

Mising district_id Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "district_id",
      "code": 1001,
      "message": "district_id cannot be empty"
    }
  ]
}

Mising address Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "address",
      "code": 1001,
      "message": "address cannot be empty"
    }
  ]
}

Mising gender Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "gender",
      "code": 1001,
      "message": "gender cannot be empty"
    }
  ]
}

Mising occupation Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "occupation",
      "code": 1001,
      "message": "occupation cannot be empty"
    }
  ]
}

Mising phone_number Field

{
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "attribute": "phone_number",
      "code": 1001,
      "message": "phone_number cannot be empty"
    }
  ]
}

Loading...