Get Registration Requests

GET 
/v1.1/customer/registration/requests

This is used by the brokerage system to see the status of the customer registration requests made by their potential customers.

Request

Query Parameters

pageNo integerrequired

Requested page number

pageWidth integerrequired

Default value: 100

Requested page width (if pageWidth > 100 : set to default)

institutionCode stringrequired

Institution code at GTN

Responses

200

OK

application/json

Schema

Schema

status stringrequired

Possible values: [SUCCESS, FAILED]

reason string
rejectCode number

Find error codes here

list object[]
Possible values: >= 1
Array [
regReqId string
firstName string
Possible values: non-empty
lastName string
familyName string
Possible values: non-empty
otherName string
Possible values: non-empty
passportNumber string
Possible values: non-empty
nin string
drivingLicense string
homeTel string
Possible values: Value must match regular expression ^\+[1-9]\d{1,14}$
officeTel string
Possible values: Value must match regular expression ^\+[1-9]\d{1,14}$
mobile string
Possible values: Value must match regular expression ^\+[1-9]\d{1,14}$
email string
Possible values: non-empty
profession string
address string
Possible values: non-empty
address2 string
city string
state string
residentCountry string
gender string
birthDate string
Possible values: Value must match regular expression yyyy/MM/dd
nationality string
status string
]
isNextPageAvailable boolean
pageWidth integer
totalNoOfRecords integer
pageNo integer

Example (from schema)

{
  "status": "SUCCESS",
  "reason": "string",
  "rejectCode": 0,
  "list": [
    {
      "regReqId": "string",
      "firstName": "string",
      "lastName": "string",
      "familyName": "string",
      "otherName": "string",
      "passportNumber": "string",
      "nin": "string",
      "drivingLicense": "string",
      "homeTel": "string",
      "officeTel": "string",
      "mobile": "string",
      "email": "string",
      "profession": "string",
      "address": "string",
      "address2": "string",
      "city": "string",
      "state": "string",
      "residentCountry": "string",
      "gender": "string",
      "birthDate": "string",
      "nationality": "string",
      "status": "string"
    }
  ],
  "isNextPageAvailable": true,
  "pageWidth": 0,
  "totalNoOfRecords": 0,
  "pageNo": 0
}

success

{
  "status": "SUCCESS",
  "reason": "Getting registration requests success",
  "rejectCode": 0,
  "isNextPageAvailable": true,
  "pageNo": 1,
  "pageWidth": 2,
  "totalNoOfRecords": 3387,
  "list": [
    {
      "regReqId": "83138",
      "firstName": "test",
      "lastName": "last",
      "familyName": "last",
      "otherName": null,
      "passportNumber": "31215225",
      "nin": null,
      "drivingLicense": null,
      "homeTel": null,
      "officeTel": null,
      "mobile": "0772345672",
      "email": "[email protected]",
      "profession": null,
      "address": "street1",
      "address2": "street2",
      "city": null,
      "state": null,
      "residentCountry": null,
      "gender": null,
      "birthDate": null,
      "nationality": null,
      "status": null
    },
    {
      "regReqId": "88799",
      "firstName": "",
      "lastName": "last",
      "familyName": "last",
      "otherName": null,
      "passportNumber": "31215225",
      "nin": null,
      "drivingLicense": null,
      "homeTel": null,
      "officeTel": null,
      "mobile": "0772345672",
      "email": "[email protected]",
      "profession": null,
      "address": "street1",
      "address2": "street2",
      "city": null,
      "state": null,
      "residentCountry": null,
      "gender": null,
      "birthDate": null,
      "nationality": null,
      "status": null
    }
  ]
}

failed

{
  "status": "SUCCESS",
  "reason": "no registration requests found",
  "rejectCode": 0,
  "isNextPageAvailable": false,
  "pageNo": 0,
  "pageWidth": 0,
  "totalNoOfRecords": 0,
  "list": []
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status string
error string
message string
path string
rejectCode string

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.1/customer/registration/requests",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.1/customer/registration/requests",
  "rejectCode": "1007"
}

Loading...