PureBasic / Broker API / CIP Info
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "{{api_key}}")
CkHttp::setCkPassword(http, "{{api_secret}}")
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "provider_name": [
; "onfido"
; ],
; "kyc": {
; "id": "CBDAD1C4-1047-450E-BAE5-B6C406F509B4",
; "risk_level": "LOW",
; "applicant_name": "John Doe",
; "email_address": "johndoe@example.com",
; "nationality": "American",
; "id_number": "jd0000123456789",
; "date_of_birth": "1970-12-01",
; "address": "42 Faux St",
; "postal_code": "94401",
; "country_of_residency": "USA",
; "kyc_completed_at": "2021-06-10T15:37:03Z",
; "ip_address": "127.0.0.1",
; "check_initiated_at": "2021-06-10T15:37:03Z",
; "check_completed_at": "2021-06-10T15:37:03Z",
; "approval_status": "approved",
; "approved_by": "Jane Doe",
; "approved_at": "2021-06-10T15:38:03Z"
; },
; "document": {
; "id": "55B9931A-3BE6-4BC0-9BDD-0B954E4A4632",
; "result": "clear",
; "status": "complete",
; "created_at": "2021-06-10T15:37:03Z",
; "image_integrity": "clear"
; },
; "photo": {
; "id": "0DD13020-F0FD-4B5A-B58F-BC1885E90A6D",
; "result": "clear",
; "status": "complete",
; "created_at": "2021-06-10T15:37:03Z",
; "face_comparison": "clear"
; },
; "identity": {
; "id": "28E1CCE8-1B1A-4472-9AD4-C6C5B7C3A6AF",
; "result": "clear",
; "status": "complete",
; "created_at": "2021-06-10T15:37:03Z",
; "sources": "clear",
; "address": "clear",
; "date_of_birth": "clear"
; },
; "watchlist": {
; "id": "7572B870-EB4C-46A2-8B88-509194CCEE7E",
; "result": "clear",
; "status": "complete",
; "created_at": "2021-06-10T15:37:03Z",
; "politically_exposed_person": "clear",
; "sanction": "clear",
; "adverse_media": "clear",
; "monitored_lists": "clear"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"provider_name[0]","onfido")
CkJsonObject::ckUpdateString(json,"kyc.id","CBDAD1C4-1047-450E-BAE5-B6C406F509B4")
CkJsonObject::ckUpdateString(json,"kyc.risk_level","LOW")
CkJsonObject::ckUpdateString(json,"kyc.applicant_name","John Doe")
CkJsonObject::ckUpdateString(json,"kyc.email_address","johndoe@example.com")
CkJsonObject::ckUpdateString(json,"kyc.nationality","American")
CkJsonObject::ckUpdateString(json,"kyc.id_number","jd0000123456789")
CkJsonObject::ckUpdateString(json,"kyc.date_of_birth","1970-12-01")
CkJsonObject::ckUpdateString(json,"kyc.address","42 Faux St")
CkJsonObject::ckUpdateString(json,"kyc.postal_code","94401")
CkJsonObject::ckUpdateString(json,"kyc.country_of_residency","USA")
CkJsonObject::ckUpdateString(json,"kyc.kyc_completed_at","2021-06-10T15:37:03Z")
CkJsonObject::ckUpdateString(json,"kyc.ip_address","127.0.0.1")
CkJsonObject::ckUpdateString(json,"kyc.check_initiated_at","2021-06-10T15:37:03Z")
CkJsonObject::ckUpdateString(json,"kyc.check_completed_at","2021-06-10T15:37:03Z")
CkJsonObject::ckUpdateString(json,"kyc.approval_status","approved")
CkJsonObject::ckUpdateString(json,"kyc.approved_by","Jane Doe")
CkJsonObject::ckUpdateString(json,"kyc.approved_at","2021-06-10T15:38:03Z")
CkJsonObject::ckUpdateString(json,"document.id","55B9931A-3BE6-4BC0-9BDD-0B954E4A4632")
CkJsonObject::ckUpdateString(json,"document.result","clear")
CkJsonObject::ckUpdateString(json,"document.status","complete")
CkJsonObject::ckUpdateString(json,"document.created_at","2021-06-10T15:37:03Z")
CkJsonObject::ckUpdateString(json,"document.image_integrity","clear")
CkJsonObject::ckUpdateString(json,"photo.id","0DD13020-F0FD-4B5A-B58F-BC1885E90A6D")
CkJsonObject::ckUpdateString(json,"photo.result","clear")
CkJsonObject::ckUpdateString(json,"photo.status","complete")
CkJsonObject::ckUpdateString(json,"photo.created_at","2021-06-10T15:37:03Z")
CkJsonObject::ckUpdateString(json,"photo.face_comparison","clear")
CkJsonObject::ckUpdateString(json,"identity.id","28E1CCE8-1B1A-4472-9AD4-C6C5B7C3A6AF")
CkJsonObject::ckUpdateString(json,"identity.result","clear")
CkJsonObject::ckUpdateString(json,"identity.status","complete")
CkJsonObject::ckUpdateString(json,"identity.created_at","2021-06-10T15:37:03Z")
CkJsonObject::ckUpdateString(json,"identity.sources","clear")
CkJsonObject::ckUpdateString(json,"identity.address","clear")
CkJsonObject::ckUpdateString(json,"identity.date_of_birth","clear")
CkJsonObject::ckUpdateString(json,"watchlist.id","7572B870-EB4C-46A2-8B88-509194CCEE7E")
CkJsonObject::ckUpdateString(json,"watchlist.result","clear")
CkJsonObject::ckUpdateString(json,"watchlist.status","complete")
CkJsonObject::ckUpdateString(json,"watchlist.created_at","2021-06-10T15:37:03Z")
CkJsonObject::ckUpdateString(json,"watchlist.politically_exposed_person","clear")
CkJsonObject::ckUpdateString(json,"watchlist.sanction","clear")
CkJsonObject::ckUpdateString(json,"watchlist.adverse_media","clear")
CkJsonObject::ckUpdateString(json,"watchlist.monitored_lists","clear")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/v1/accounts/:account_id/cip","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-u '{{api_key}}:{{api_secret}}'
-d '{
"provider_name": ["onfido"],
"kyc": {
"id": "CBDAD1C4-1047-450E-BAE5-B6C406F509B4",
"risk_level": "LOW",
"applicant_name": "John Doe",
"email_address": "johndoe@example.com",
"nationality": "American",
"id_number": "jd0000123456789",
"date_of_birth": "1970-12-01",
"address": "42 Faux St",
"postal_code": "94401",
"country_of_residency": "USA",
"kyc_completed_at": "2021-06-10T15:37:03Z",
"ip_address": "127.0.0.1",
"check_initiated_at": "2021-06-10T15:37:03Z",
"check_completed_at": "2021-06-10T15:37:03Z",
"approval_status": "approved",
"approved_by": "Jane Doe",
"approved_at": "2021-06-10T15:38:03Z"
},
"document": {
"id": "55B9931A-3BE6-4BC0-9BDD-0B954E4A4632",
"result": "clear",
"status": "complete",
"created_at": "2021-06-10T15:37:03Z",
"image_integrity": "clear"
},
"photo": {
"id": "0DD13020-F0FD-4B5A-B58F-BC1885E90A6D",
"result": "clear",
"status": "complete",
"created_at": "2021-06-10T15:37:03Z",
"face_comparison": "clear"
},
"identity": {
"id": "28E1CCE8-1B1A-4472-9AD4-C6C5B7C3A6AF",
"result": "clear",
"status": "complete",
"created_at": "2021-06-10T15:37:03Z",
"sources": "clear",
"address": "clear",
"date_of_birth": "clear"
},
"watchlist": {
"id": "7572B870-EB4C-46A2-8B88-509194CCEE7E",
"result": "clear",
"status": "complete",
"created_at": "2021-06-10T15:37:03Z",
"politically_exposed_person": "clear",
"sanction": "clear",
"adverse_media": "clear",
"monitored_lists": "clear"
}
}'
https://domain.com/v1/accounts/:account_id/cip
Postman Collection Item JSON
{
"name": "CIP Info",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"provider_name\": [\"onfido\"],\n \"kyc\": {\n \"id\": \"CBDAD1C4-1047-450E-BAE5-B6C406F509B4\",\n \"risk_level\": \"LOW\",\n \"applicant_name\": \"John Doe\",\n \"email_address\": \"johndoe@example.com\",\n \"nationality\": \"American\",\n \"id_number\": \"jd0000123456789\",\n \"date_of_birth\": \"1970-12-01\",\n \"address\": \"42 Faux St\",\n \"postal_code\": \"94401\",\n \"country_of_residency\": \"USA\",\n \"kyc_completed_at\": \"2021-06-10T15:37:03Z\",\n \"ip_address\": \"127.0.0.1\",\n \"check_initiated_at\": \"2021-06-10T15:37:03Z\",\n \"check_completed_at\": \"2021-06-10T15:37:03Z\",\n \"approval_status\": \"approved\",\n \"approved_by\": \"Jane Doe\",\n \"approved_at\": \"2021-06-10T15:38:03Z\"\n },\n \"document\": {\n \"id\": \"55B9931A-3BE6-4BC0-9BDD-0B954E4A4632\",\n \"result\": \"clear\",\n \"status\": \"complete\",\n \"created_at\": \"2021-06-10T15:37:03Z\",\n \"image_integrity\": \"clear\"\n },\n \"photo\": {\n \"id\": \"0DD13020-F0FD-4B5A-B58F-BC1885E90A6D\",\n \"result\": \"clear\",\n \"status\": \"complete\",\n \"created_at\": \"2021-06-10T15:37:03Z\",\n \"face_comparison\": \"clear\"\n },\n \"identity\": {\n \"id\": \"28E1CCE8-1B1A-4472-9AD4-C6C5B7C3A6AF\",\n \"result\": \"clear\",\n \"status\": \"complete\",\n \"created_at\": \"2021-06-10T15:37:03Z\",\n \"sources\": \"clear\",\n \"address\": \"clear\",\n \"date_of_birth\": \"clear\"\n },\n \"watchlist\": {\n \"id\": \"7572B870-EB4C-46A2-8B88-509194CCEE7E\",\n \"result\": \"clear\",\n \"status\": \"complete\",\n \"created_at\": \"2021-06-10T15:37:03Z\",\n \"politically_exposed_person\": \"clear\",\n \"sanction\": \"clear\",\n \"adverse_media\": \"clear\",\n \"monitored_lists\": \"clear\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{HOST}}/v1/accounts/:account_id/cip",
"host": [
"{{HOST}}"
],
"path": [
"v1",
"accounts",
":account_id",
"cip"
],
"variable": [
{
"key": "account_id",
"value": null
}
]
},
"description": "| Attribute | Requirement |\n| ---------------|:-------------: |\n| `provider` | Optional |\n| `kyc` | Optional |\n| `document` | Optional |\n| `photo` | Optional |\n| `identity` | Optional |\n| `watchlist` | Optional |"
},
"response": [
]
}
