Objective-C / Broker API / CIP Info
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"{{api_key}}";
http.Password = @"{{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"
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"provider_name[0]" value: @"onfido"];
[json UpdateString: @"kyc.id" value: @"CBDAD1C4-1047-450E-BAE5-B6C406F509B4"];
[json UpdateString: @"kyc.risk_level" value: @"LOW"];
[json UpdateString: @"kyc.applicant_name" value: @"John Doe"];
[json UpdateString: @"kyc.email_address" value: @"johndoe@example.com"];
[json UpdateString: @"kyc.nationality" value: @"American"];
[json UpdateString: @"kyc.id_number" value: @"jd0000123456789"];
[json UpdateString: @"kyc.date_of_birth" value: @"1970-12-01"];
[json UpdateString: @"kyc.address" value: @"42 Faux St"];
[json UpdateString: @"kyc.postal_code" value: @"94401"];
[json UpdateString: @"kyc.country_of_residency" value: @"USA"];
[json UpdateString: @"kyc.kyc_completed_at" value: @"2021-06-10T15:37:03Z"];
[json UpdateString: @"kyc.ip_address" value: @"127.0.0.1"];
[json UpdateString: @"kyc.check_initiated_at" value: @"2021-06-10T15:37:03Z"];
[json UpdateString: @"kyc.check_completed_at" value: @"2021-06-10T15:37:03Z"];
[json UpdateString: @"kyc.approval_status" value: @"approved"];
[json UpdateString: @"kyc.approved_by" value: @"Jane Doe"];
[json UpdateString: @"kyc.approved_at" value: @"2021-06-10T15:38:03Z"];
[json UpdateString: @"document.id" value: @"55B9931A-3BE6-4BC0-9BDD-0B954E4A4632"];
[json UpdateString: @"document.result" value: @"clear"];
[json UpdateString: @"document.status" value: @"complete"];
[json UpdateString: @"document.created_at" value: @"2021-06-10T15:37:03Z"];
[json UpdateString: @"document.image_integrity" value: @"clear"];
[json UpdateString: @"photo.id" value: @"0DD13020-F0FD-4B5A-B58F-BC1885E90A6D"];
[json UpdateString: @"photo.result" value: @"clear"];
[json UpdateString: @"photo.status" value: @"complete"];
[json UpdateString: @"photo.created_at" value: @"2021-06-10T15:37:03Z"];
[json UpdateString: @"photo.face_comparison" value: @"clear"];
[json UpdateString: @"identity.id" value: @"28E1CCE8-1B1A-4472-9AD4-C6C5B7C3A6AF"];
[json UpdateString: @"identity.result" value: @"clear"];
[json UpdateString: @"identity.status" value: @"complete"];
[json UpdateString: @"identity.created_at" value: @"2021-06-10T15:37:03Z"];
[json UpdateString: @"identity.sources" value: @"clear"];
[json UpdateString: @"identity.address" value: @"clear"];
[json UpdateString: @"identity.date_of_birth" value: @"clear"];
[json UpdateString: @"watchlist.id" value: @"7572B870-EB4C-46A2-8B88-509194CCEE7E"];
[json UpdateString: @"watchlist.result" value: @"clear"];
[json UpdateString: @"watchlist.status" value: @"complete"];
[json UpdateString: @"watchlist.created_at" value: @"2021-06-10T15:37:03Z"];
[json UpdateString: @"watchlist.politically_exposed_person" value: @"clear"];
[json UpdateString: @"watchlist.sanction" value: @"clear"];
[json UpdateString: @"watchlist.adverse_media" value: @"clear"];
[json UpdateString: @"watchlist.monitored_lists" value: @"clear"];
CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/v1/accounts/:account_id/cip" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);
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": [
]
}
