# Home ## Introduction Synapses is an integrated **all-in-one** platform from Kredibel, offering **Anti-fraud**, **Anti Money Laundering**, and **Counter-Terrorism Financial Service**. ## Products ![Kredibel Workflows](/files/-Mcweoj7xnC3132oOA5v) Make smarter decisions with our real-time fraud detection. Our solutions help you to onboard more good users, comply with government regulations, and reduce fraud rates. ### Fraud Detection System Monitor your transactions in real-time. Reject fraudulent transactions, review suspicious transactions, and accept legitimate transactions. Reduce fraud rates, and increase conversions. #### API References * [Account Screening](/api-references/account-screening) ### Customer Due Diligence Identify risks by performing customer due diligence with Kredibel's AML Databases of PEPs, Sanctions, and Watchlists in a structured profile. #### API References * [Watchlist Screening](/api-references/account-screening/watchlist-screening) ### Know Your Customer Shorten customer onboarding process and increase conversions. Onboard more good customers with Kredibel VisionAI technology. #### API References * [Identity Verification](/api-references/identity-verification) * [Text Recognition](/api-references/text-recognition) * [Face Recognition](/api-references/face-recognition) ## Pages ### Dashboard | Environment | URL | | ----------- | ------------------------------------------------------------------------------------------------------------------------ | | Production | [synapses.kredibel.com ](https://synapses.kredibel.co.id) | | Development | [synapses.sandbox.kredibel.com](https://synapses.sandbox.kredibel.co.id)[ ](https://synapses.sandbox.kredibel.co.id) | ## Support | Channel | Value | | ------- | -------------------------- | | Email | | # Security ## Compliances Kredibel is certified **ISO 27001:2013** (Information Security Management System) company. Kredibel also listed as *Penyelenggara Sistem Elektronik* (**PSE KOMINFO**) in Indonesia. | Type | Number | | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ISO 27001:2013 | [ISMS1001153](https://www.cbqaglobal.com/validation/company/pt-kredibel-teknologi-indonesia/) | | PSE KOMINFO | [001901.01/DJAI.PSE/01/2022](https://pse.kominfo.go.id/tdpse-detail/2964) (SE Baru) & [03033/DJAI.PSE/10/2020](https://pse.kominfo.go.id/sistem/4069) (SE Lama) | ## Encryption All sensitive informations are encrypted with **AES-GCM** with a 256-bit AES key and a 96-bit nonce**.** We use our dedicated vault management system to encrypt and decrypt data. Decryption keys are safely stored on **separate machines**. ## Manage Data Kredibel allows you to fully managed your data. You can easily delete data from your [Synapses Dashboard](/#pages). {% hint style="danger" %} When you delete the history, the data will be **hard deleted**. That means you **cannot restore** data that you have deleted. {% endhint %} 1. Login to [Synapses Dashboard ](/#pages) 2. Open the history data you want to delete 3. Click "**Delete Selected (n)**" or "**Delete All**" # Scoring Engine ## Introduction At Kredibel, we know every company and use case requires different configurations and scoring rules. That's why we created Scoring Engine, a tool that helps you to fully customize your risk scoring according to your use case and needs. {% hint style="info" %} Scoring engine can only be applied to [account screening](/api-references/account-screening) {% endhint %} Custom Config and Rules Synapses API allows you to set up a custom configuration and define custom rules. To use custom config and rules, you need to create it first from the synapses dashboard. ### Create New Config ![Custom Config](/files/-MfyvELXwBMwFtor1RAV) 1. Login to [Synapses dashboard ](/#pages) 2. Click the “**Config**” menu on the sidebar 3. Click "**Add New**" button 4. Add config’s name 5. Setup the config and add some rules 6. Save the config by click "**Create New**" button 7. Your configId is on the id column ### Create New Rules ![Custom Rules](/files/-Mfyv_vY3y-7LGzi9L5G) 1. Open your existing config or [create a new one](/system/scoring-engine#create-new-config) 2. Click tab "**Rules**" 3. Click "**Add New Rule**" button 4. Define the rule 5. Click "**Save Changes"** button ### How to Use {% hint style="info" %} Please read the [documentation](/api-references/account-screening#custom-config-and-rules) here {% endhint %} # Blacklist & Whitelist If you have your own blacklist and whitelist data, you can easily add them to Kredibel. ### Available List Features * Bank Account * Phone Number * Email Address * IP Address * Identity ## Add New Data ![Data List](/files/-MfyyuQDlO73uO6dYshO) 1. Login to [Synapses dashboard ](/#pages) 2. Click the "**Fraud Detection**" > "**Account List**" menu on the sidebar 3. Click the "**Add New**" button 4. Input the data # Team Management ![Team Management](/files/-MfyzMWyOtFDTe5dZUU_) Kredibel allows you to collaborate by inviting your teammates to the dashboard. ## Invite User 1. Login to [Synapses dashboard ](/#pages) 2. Click "**Team Management**" menu on the sidebar 3. Click "**Add New**" button 4. Input email and role ### User Roles | Roles | Description | | --------- | ------------------------------------------------------------- | | Admin | Access all features and pages | | Developer | Access only developer page | | User | Access all features except developer page and team management | # Getting Started New to Kredibel? Don't worry, we're here to help you to integrate with our system. ## Start 1. [Environment](/environment) 2. [Authorization](/authentication-1) ## Use Cases ### User Onboarding #### Identify Risk * [Account Screening](/api-references/account-screening) #### Faster Onboarding * [Text Recognition](/api-references/text-recognition) * [Face Comparison](/api-references/face-recognition/face-comparison) # Environment Kredibel currently has two different environments, **sandbox** and **production**. The sandbox environment is only intended for the development or integration stage of the service. Meanwhile, the production environment is used when the integration status has entered the production stage. Both of these environments have different network topologies and architectures. For example, we use a multi-zone data center in a production environment that can autoscale and fault tolerance for achieving high availability, while the sandbox environment only uses a single-zone data center. {% hint style="info" %} After completing the integration, you only need to change the **endpoint** to the production endpoints and replace the **token** with the production token. {% endhint %} # Authorization Synapses API uses API keys to authenticate requests. These API keys can be generated from [synapses.kredibel.com](https://synapses.kredibel.com) or [synapses.sandbox.kredibel.com](https://synapses.sandbox.kredibel.com) for development purposes and must be supplied with each request. ## Generating API Key 1. Login to[ Synapses dashboard ](/#pages) 2. Click on the `Setting` -> `API Token` or directly visit [``](/#pages)`/developer/token` 3. Click “**Generate**” ## Using API Key An API key is a token that a client provides when making API calls. Synapses API provides two methods for authentication. 1. As a query string parameter | Method | Key | | -------- | ----------------- | | **POST** |

{ |

"key": "YOUR_API_KEY"

}

| | **GET** | `/v1/example?key=`**`YOUR_API_KEY`** | 2. In the authorization header\ `"Authorization: Bearer`` `**`YOUR_API_KEY`**`"` {% hint style="info" %} Both of the methods above work with Synapses API. The query string is easier to implement. But, makes it easier to discover for someone who should not have access to it. For every API call, we recommend using an **authorization header** since it is more secure. {% endhint %} # Responses & Errors {% hint style="info" %} Our API uses standard HTTP codes to indicate if the request is successful or failed {% endhint %} Successful requests will return both a `“message”` and `“data”` field with a 2XX status code. Data can be represented by an object or array type. ``` { "message": "Response message", "data": { # Response should be here } } ``` ``` { "message": "Response message", "data": [ # Response should be here ] } ``` Unsuccessful requests will return a “message” field containing the error message, with 4XX or 5XX status code. **Common error message** ``` { "message": "Error message." } ``` **Error message with error id** {% hint style="info" %} If you experience issues or errors while using our service, we highly recommend that you contact us by providing the **`errorId`** that you get along with the error message. That way, our team can easily trace the issue {% endhint %} ``` { "errors": { "errorId": }, "message": "Error message." } ``` **Error message with error type** ``` { "errors":{ "errorId": , "errorType": }, "message": "Error message." } ``` **Validation error** ``` { "errors": { "fieldName": [ "Unknown field." ] }, "message": "Input payload validation failed." } ``` # Account Screening ## Introduction Account screening is an endpoint that can be used for many use cases. It’s an **all-in-one** API that helps you onboard more good users, comply with government regulations, and reduce fraud rates. {% embed url="" %} ## Endpoints | Method | URL | | ------ | -------------------------------- | | POST | `$synapses/v1/account/screening` | ## Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ## Custom Config and Rules To start using custom config and rules, you need to [create a config](/system/scoring-engine#create-new-config). Then, after you create a config and get `configId` you can use it by defining `configId` like the code below supplied in Account Screening. ![Config List](/files/-Mfyxr5gbJwp4L-yC0v2) ``` { "configId": "", ... } ``` ## General Response {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------ | -------------------------------------------------------------- | ------------------------------------------------ | | id | String | Unique identifier. | | score | Float | The accumulated value of all credibility scores. | | status |

String

\["pass", "review", "reject"]

|

Pass: Everything is alright. |

Review: There is something to be suspected. You have to check it manually.

Reject: Potentially of high risk account.

| {% endtab %} {% tab title="Example" %} ``` { "message": "Account Screening - Single.", "data": { "id": "28b78927-8546-45fd-ba9f-17239bf366a9", "score": -15, "status": "review", ... } ``` {% endtab %} {% endtabs %} ## Modules To start using Account Screening Service, you must define at least **one or more** modules that you want to use. * [Bank Account](/api-references/account-screening/bank-account) * [Phone Number ](/api-references/account-screening/phone-number) * [Email Address ](/api-references/account-screening/email-address) * [IP Address ](/api-references/account-screening/ip-address) * [AML ](/api-references/account-screening/watchlist-screening)[Screening](/api-references/account-screening/watchlist-screening) * [KYC Identity Module ](broken://pages/-McxZGFzhvdQORS_ppAI) * [KYC Face Module ](broken://pages/-McxZGcKxisa1ekZdky-) # Watchlist Screening You can use the Watchlist Screening module by defining a person's fullName to your JSON request. For a specific search, you can add birthDate and gender as a filter or using a pseudo filter. ## Description A watchlist screening (AML/CFT) is a solution that helps financial institutions and other organizations comply with anti-money laundering (AML) and counter-financing of terrorism (CFT) regulations. This solution allows organizations to search for and identify potential matches against a list of known or suspected individuals and entities involved in money laundering or terrorist financing activities. ## Endpoints | Method | URL | | ------ | ------------------------------------ | | POST | `$synapses`**/v1/account/screening** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ## **Using Standard Filter** ### **Request** {% tabs %} {% tab title="Description" %}
FieldTypeDescription
FieldTypeDescription

fullName

(Required)

StringFull name of the person you want to check
fullNameFilterTitleBooleanIf true, then the academic degree on the name input will be filtered
e.g. "Drs. Setya Novanto" -> "Setya Novanto"

Note:
- Default is false
birthDate

Date

("yyyy-mm-dd")

Birthdate of the person
birthPlaceStringBirthplace of the person
gender

String

["male", "female"]

Gender of the person
countryStringCountry of the person

e.g. Indonesia
searchAliasFieldsString [Array]
["nativeName", "alias", "lowAliases", "previousAliases", "spellingVariationNames", "languageVariationNames", "maidenNames"]		Match the fullName query with the fields
searchType

String

["match", "match_exact"]

Type of the searching algorithm

Note:
- match: fuzzy searching (default, recommended)
- exact match: only return 100% match
searchSimilarityAlgorithmString
["levenshtein", "n-gram"]		Type of the similarity algorithm used for searching

Note:
- levenshtein: (default, recommended)
- n-gram: similarity between "Habibie" and "B.J. Habibie" is 100% match
searchDataSourcesString [array]
["kredibel"]		Data source used for searching
profileTypesString [array]
["PEP", "RCA", "SIP", "Sanction", "Watchlist", "Crime"]		List of the profile types you want to check
crimeCategoriesString [array]Profile related to the category of crime you want to search
ongoingScreeningBooleanIf true, then Kredibel system will do regular monitoring. It means, you'll get notified when there is an update to the result.

Note:
- Only available for transaction monitoring subscription
minSimilarity

Float

(0-1)

The minimum similarity of the result between the query name and the result name
e.g. if the treshold is 0.8, then only result has >= 0.8 (80%) match displayed

Note:
- default treshold is 0.8

- 0.5 = 50%, 1 = 100% match

{% endtab %} {% tab title="Example (Full)" %} ``` { "fullName": "Joko Widodo", "fullNameFilterTitle": false, "birthDate": "1961-06-21", "birthPlace": "Surakarta", "gender": "male", "country": "Indonesia", "searchType": "match", "searchAliasFields": ["nativeName", "alias", "lowAliases", "previousAliases", "spellingVariationNames", "languageVariationNames", "maidenNames"], "searchDataSources": ["kredibel"], "searchSimilarityAlgorithm": "levenshtein", "profileTypes": ["PEP", "SIP", "RCA", "Sanction", "Watchlist"], "ongoingScreening": true, "minSimilarity": 0.8 } ``` {% endtab %} {% tab title="Example (Simple)" %} ``` { "fullName": "Joko Widodo" } ``` {% endtab %} {% tab title="Example (Recommend)" %} ``` { "fullName": "Joko Widodo", "birthDate": "1961-06-21" } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------------------ | -------- | -------------------------------------- | | id | `String` | Unique identifier of PEP search result | |

fullName

| | |

| `String` | Name of the person you search | | birthPlace | `String` | Birthplace of the person you search | | birthDate |

Date

("yyyy-mm-dd")

| Birthdate of the person you search | | gender | `String` | Gender of the person you search | | country | `String` | Country of the person you search | | totalCount | `Integer` | Number of total matches profile | | maxSimilarity | `Float` | Maximum similarity value between your query and matches profile | | result | `Array` | List of matches politically exposed persons | | [riskLevel](#risk-level) |

String
["high", "medium", "low", "unknown"]

| Level of risk | | score | `Float` | Credibility score | {% endtab %} {% tab title="Example" %} ``` { "message": "Watchlist screening", "data": { "id": "540d9073-62a3-4ea9-8693-ef9e5487e509", "fullName": "Joko Widodo", "birthPlace": "Surakarta", "birthDate": "1961-06-21", "gender": "male", "country": "Indonesia", "totalCount": 1, "totalSanctionCount": 0, "totalWatchlistCount": 0, "totalPepCount": 1, "totalRcaCount": 0, "totalSipCount": 0, "totalCrimeCount": 0, "maxSimilarity": 1.0, "kredibel": { "count": 1, "sanctionCount": 0, "watchlistCount": 0, "pepCount": 1, "rcaCount": 0, "sipCount": 0, "crimeCount": 0, "maxSimilarity": 1.0, "result": [ { "id": "66499d4f2099f613265313cee676cd1b", "entity": "person", "name": "Joko Widodo", "nativeName": "Joko Widodo", "gender": "male", "birthPlace": "Surakarta, Central Java, Indonesia", "birthDate": "1961-06-21 00:00:00", "deathDate": null, "description": "Presiden Indonesia ke-7 (2014-Sekarang)", "detailDescription": "Ir. H. Joko Widodo adalah presiden Indonesia yang mulai menjabat sejak tanggal 20 Oktober 2014. Terpilih dalam Pemilu Presiden 2014, Jokowi menjadi presiden Indonesia pertama yang bukan berasal dari elite politik atau militer Indonesia. Dia terpilih bersama Wakil Presiden Jusuf Kalla dan kembali terpilih bersama Wakil Presiden Ma'ruf Amin dalam Pemilu Presiden 2019. Sebelumnya, Jokowi pernah menjabat sebagai gubernur Jakarta sejak 15 Oktober 2012 hingga 16 Oktober 2014 didampingi Basuki Tjahaja Purnama sebagai wakil gubernur. [Wikipedia]", "updatedAt": null, "alias": [ "Jokowi", "President Joko Widodo", "Џокови", "佐科·维多多", "Haji Joko Widodo", "佐科威", "Джокови", "Cokovi", "Мульоно", "Джокоуи", "Preisdent Jokowi", "جۆکۆوی", "Džokovi", "Mulyono", "Ir. H. Joko Widodo" ], "lowAliases": [], "previousAliases": [], "maidenNames": [], "spellingVariationNames": [], "languageVariationNames": [ "جوکو ویدودو", "Џоко Видодо", "佐科·维多多", "Τζόκο Ουιντόντο", "佐科·維多多", "جوكو ويدودو", "ג'וקו וידודו", "Joko Widodo", "ဂျိုကို ဝီဒိုဒို", "जोको विडोडो", "جوکو ودودو", "Җоко Видодо", "ജോക്കോ വിഡൊഡൊ", "佐戈", "Coko Vidodo", "জোকো উইদোদো", "โจโก วีโดโด", "조코 위도도", "ចូកូ វីដូដូ", "ஜோக்கோ விடோடோ", "Ջոկո Վիդոդո", "جوکو ويدودو", "جوڪو ودودو", "ジョコ・ウィドド", "Джоко Видодо", "Джоко Уидодо", "Ճոքօ Ուիտոտօ", "Džoko Vidodo", "Ҷоко Видодо", "ਜੋਕੋ ਵਿਡੋਡੋ", "جۆکۆ ویدۆدۆ", "ჯოკო ვიდოდო", "Джоко Відодо", "Джока Відода" ], "birthPlaces": [], "birthDates": [], "images": [ "https://img.kredibel.co.id/politiface/profile/ac1aff11543cd387827c68a3371c72f0.png" ], "roles": [ { "level": null, "endDate": null, "location": null, "roleType": null, "startDate": "2014-10-20 00:00:00", "occupationTitle": "President of Indonesia" }, { "level": null, "endDate": "2014-10-20 00:00:00", "location": null, "roleType": null, "startDate": "2012-10-15 00:00:00", "occupationTitle": "Governor of the Special Capital Region of Jakarta" }, { "level": null, "endDate": "2012-10-01 00:00:00", "location": null, "roleType": null, "startDate": "2005-07-28 00:00:00", "occupationTitle": "Mayor of Surakarta" } ], "residents": [ { "type": "citizenship", "value": "Indonesia" } ], "crimes": [], "sanctions": [], "types": [ "PEP" ], "profileUrl": "https://synapses.sandbox.kredibel.com/watchlist/profile/540d9073-62a3-4ea9-8693-ef9e5487e509/66499d4f2099f613265313cee676cd1b", "similarity": 1.0, "dataset": "int-watchlist", "matchFields": [ "name", "birthDate" ] } ], "start": 1, "size": 10 }, "riskLevel": "medium", "score": -15.0 } } ``` {% endtab %} {% endtabs %} ## **Using Pseudo Filter (Recommended Method)** {% hint style="info" %} If you use a standard filter, data that has no date of birth will not be displayed. With a pseudo filter, you will get data that match with a query or does not have the attributes. {% endhint %} ### **Request** {% tabs %} {% tab title="Description" %}
FieldTypeDescription
FieldTypeDescription

fullName

(Required)

StringFull name of the person you want to check
fullNameFilterTitleBooleanIf true, then the academic degree on the name input will be filtered
e.g. "Drs. Setya Novanto" -> "Setya Novanto"

Note:
- Default is false
pseudoBirthDate

Date

("yyyy-mm-dd")

Birthdate of the person
pseudoBirthPlaceStringBirthplace of the person
pseudoGender

String

["male", "female"]

Gender of the person
pseudoCountryStringCountry of the person

e.g. Indonesia
searchAliasFieldsString [Array]
["nativeName", "alias", "lowAliases", "previousAliases", "spellingVariationNames", "languageVariationNames", "maidenNames"]		Match the fullName query with the fields
searchType

String

["match", "match_exact"]

Type of the searching algorithm

Note:
- match: fuzzy searching (default, recommended)
- exact match: only return 100% match
searchSimilarityAlgorithmString
["levenshtein", "n-gram"]		Type of the similarity algorithm used for searching

Note:
- levenshtein: (default, recommended)
- n-gram: similarity between "Habibie" and "B.J. Habibie" is 100% match
searchDataSourcesString [array]
["kredibel"]		Data source used for searching
profileTypesString [array]
["PEP", "RCA", "SIP", "Sanction", "Watchlist", "Crime"]		List of the profile types you want to check
profileCategoriesString [array]Profile related to the category of crime you want to search
ongoingScreeningBooleanIf true, then Kredibel system will do regular monitoring. It means, you'll get notified when there is an update to the result.

Note:
- Only available for transaction monitoring subscription
minSimilarity

Float

(0-1)

The minimum similarity of the result between the query name and the result name
e.g. if the treshold is 0.8, then only result has >= 0.8 (80%) match displayed

Note:
- default treshold is 0.8

- 0.5 = 50%, 1 = 100% match

pseudoMinSimilarity

Float

(0-1)

The minimum similarity of the result between the query name and the pseudoResult name

Note:
- default treshold is 1
{% endtab %} {% tab title="Example (Full)" %} ``` { "fullName": "Joko Widodo", "fullNameFilterTitle": false, "pseudoBirthDate": "1961-06-21", "pseudoBirthPlace": "Surakarta", "pseudoGender": "male", "pseudoCountry": "Indonesia", "searchType": "match", "searchAliasFields": ["nativeName", "alias", "lowAliases", "previousAliases", "spellingVariationNames", "languageVariationNames", "maidenNames"], "searchDataSources": ["kredibel"], "searchSimilarityAlgorithm": "levenshtein", "profileTypes": ["PEP", "SIP", "RCA", "Sanction", "Watchlist"], "ongoingScreening": true, "minSimilarity": 0.8, "pseudoMinSimilarity": 0.8 } ``` {% endtab %} {% tab title="Example (Simple)" %} ``` { "fullName": "Joko Widodo" } ``` {% endtab %} {% tab title="Example (Recommend)" %} ``` { "fullName": "Joko Widodo", "pseudoBirthDate": "1961-06-21", "pseudoBirthPlace": "Surakarta", "pseudoGender": "male", "pseudoCountry": "Indonesia" } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------------------ | -------- | -------------------------------------- | | id | `String` | Unique identifier of PEP search result | |

fullName

| | |

| `String` | Name of the person you search | | birthPlace | `String` | Birthplace of the person you search | | birthDate |

Date

("yyyy-mm-dd")

| Birthdate of the person you search | | gender | `String` | Gender of the person you search | | country | `String` | Country of the person you search | | totalCount | `Integer` | Number of total matches profile | | maxSimilarity | `Float` | Maximum similarity value between your query and matches profile | | pseudoMaxSimilarity | `Float` | Maximum similarity value between your query and pseudo matches profile | | result | `Array` | List of matches politically exposed persons | | pseudoResult | `Array` | List of matches politically exposed persons with pseudoFilter | | [riskLevel](#risk-level) |

String
["high", "medium", "low", "unknown"]

| Level of risk | | score | `Float` | Credibility score | {% endtab %} {% tab title="Example" %} ``` { "message": "Watchlist screening", "data": { "id": "bbfd43f3-ae91-4fd0-ba62-eaa177282aff", "fullName": "Joko Widodo", "birthPlace": "Surakarta", "birthDate": "1961-06-21", "gender": "male", "country": "Indonesia", "totalCount": 1, "totalPseudoCount": 0, "totalSanctionCount": 0, "totalPseudoSanctionCount": 0, "totalWatchlistCount": 0, "totalPseudoWatchlistCount": 0, "totalPepCount": 1, "totalPseudoPepCount": 0, "totalRcaCount": 0, "totalPseudoRcaCount": 0, "totalSipCount": 0, "totalPseudoSipCount": 0, "totalCrimeCount": 0, "totalPseudoCrimeCount": 0, "maxSimilarity": 1.0, "pseudoMaxSimilarity": 0, "kredibel": { "count": 1, "pseudoCount": 0, "sanctionCount": 0, "pseudoSanctionCount": 0, "watchlistCount": 0, "pseudoWatchlistCount": 0, "pepCount": 1, "pseudoPepCount": 0, "rcaCount": 0, "pseudoRcaCount": 0, "sipCount": 0, "pseudoSipCount": 0, "crimeCount": 0, "pseudoCrimeCount": 0, "maxSimilarity": 1.0, "pseudoMaxSimilarity": 0, "result": [ { "id": "66499d4f2099f613265313cee676cd1b", "entity": "person", "name": "Joko Widodo", "nativeName": "Joko Widodo", "gender": "male", "birthPlace": "Surakarta, Central Java, Indonesia", "birthDate": "1961-06-21 00:00:00", "deathDate": null, "description": "Presiden Indonesia ke-7 (2014-Sekarang)", "detailDescription": "Ir. H. Joko Widodo adalah presiden Indonesia yang mulai menjabat sejak tanggal 20 Oktober 2014. Terpilih dalam Pemilu Presiden 2014, Jokowi menjadi presiden Indonesia pertama yang bukan berasal dari elite politik atau militer Indonesia. Dia terpilih bersama Wakil Presiden Jusuf Kalla dan kembali terpilih bersama Wakil Presiden Ma'ruf Amin dalam Pemilu Presiden 2019. Sebelumnya, Jokowi pernah menjabat sebagai gubernur Jakarta sejak 15 Oktober 2012 hingga 16 Oktober 2014 didampingi Basuki Tjahaja Purnama sebagai wakil gubernur. [Wikipedia]", "updatedAt": null, "alias": [ "Jokowi", "President Joko Widodo", "Џокови", "佐科·维多多", "Haji Joko Widodo", "佐科威", "Джокови", "Cokovi", "Мульоно", "Джокоуи", "Preisdent Jokowi", "جۆکۆوی", "Džokovi", "Mulyono", "Ir. H. Joko Widodo" ], "lowAliases": [], "previousAliases": [], "maidenNames": [], "spellingVariationNames": [], "languageVariationNames": [ "جوکو ویدودو", "Џоко Видодо", "佐科·维多多", "Τζόκο Ουιντόντο", "佐科·維多多", "جوكو ويدودو", "ג'וקו וידודו", "Joko Widodo", "ဂျိုကို ဝီဒိုဒို", "जोको विडोडो", "جوکو ودودو", "Җоко Видодо", "ജോക്കോ വിഡൊഡൊ", "佐戈", "Coko Vidodo", "জোকো উইদোদো", "โจโก วีโดโด", "조코 위도도", "ចូកូ វីដូដូ", "ஜோக்கோ விடோடோ", "Ջոկո Վիդոդո", "جوکو ويدودو", "جوڪو ودودو", "ジョコ・ウィドド", "Джоко Видодо", "Джоко Уидодо", "Ճոքօ Ուիտոտօ", "Džoko Vidodo", "Ҷоко Видодо", "ਜੋਕੋ ਵਿਡੋਡੋ", "جۆکۆ ویدۆدۆ", "ჯოკო ვიდოდო", "Джоко Відодо", "Джока Відода" ], "birthPlaces": [], "birthDates": [], "images": [ "https://img.kredibel.co.id/politiface/profile/ac1aff11543cd387827c68a3371c72f0.png" ], "roles": [ { "level": null, "endDate": null, "location": null, "roleType": null, "startDate": "2014-10-20 00:00:00", "occupationTitle": "President of Indonesia" }, { "level": null, "endDate": "2014-10-20 00:00:00", "location": null, "roleType": null, "startDate": "2012-10-15 00:00:00", "occupationTitle": "Governor of the Special Capital Region of Jakarta" }, { "level": null, "endDate": "2012-10-01 00:00:00", "location": null, "roleType": null, "startDate": "2005-07-28 00:00:00", "occupationTitle": "Mayor of Surakarta" } ], "residents": [ { "type": "citizenship", "value": "Indonesia" } ], "crimes": [], "sanctions": [], "types": [ "PEP" ], "profileUrl": "https://synapses.sandbox.kredibel.com/watchlist/profile/bbfd43f3-ae91-4fd0-ba62-eaa177282aff/66499d4f2099f613265313cee676cd1b", "similarity": 1.0, "dataset": "int-watchlist", "matchFields": [ "name", "pseudoBirthDate" ] } ], "pseudoResult": [], "start": 1, "size": 10 }, "riskLevel": "medium", "score": -15.0 } } ``` {% endtab %} {% endtabs %} ## Knowledge #### **Profile Types** {% tabs %} {% tab title="List" %}
TypesDefinition
PEPA Politically Exposed Person (PEP) is an individual who holds a prominent public position or has held such a position in the recent past. This can include government officials, high-ranking military officers, heads of state-owned enterprises, and leaders of political parties.
RCARelative and Close Associates (RCA) refers to Individuals who are closely related to a Politically Exposed Person (PEP). This can include immediate family members, such as spouses, children, and parents, as well as individuals with close business or personal relationships with the PEP. These individuals are considered high-risk for involvement in money laundering or terrorist financing due to their association with the PEP.
SIPA Special Interest Person is an individual or entity that, while not necessarily a PEP, possesses a higher risk profile due to their involvement in industries or activities that are susceptible to money laundering or terrorist financing. These could include sectors like gambling, real estate, and non-profit organizations. SIPs are subject to closer scrutiny during AML/CFT procedures.
SanctionSanctions are punitive measures imposed by governments, international organizations, or regulatory bodies to deter and punish individuals, entities, or countries that have violated laws, regulations, or international agreements. Sanctions are typically imposed to address specific concerns, such as human rights abuses, proliferation of weapons of mass destruction, or support for terrorism.
WatchlistA watchlist is a database maintained by financial institutions, law enforcement agencies, and regulatory bodies to identify individuals, entities, or organizations that are suspected or confirmed to be involved in money laundering, terrorist financing, or other illicit activities. Watchlists are used to enhance due diligence and screening processes.
CrimeOther criminal categories other than those related to AML/CFT.
{% endtab %} {% tab title="Code" %} ``` ["PEP", "RCA", "SIP", "Sanction", "Watchlist", "Crime"] ``` {% endtab %} {% endtabs %} #### **Crime Categories** {% tabs %} {% tab title="List" %}
#CategoriesVersion
1corruption1.0
2terrorism1.0
3national-security1.1
4gambling1.0
5embezzlement1.0
6fraud1.0
7money-laundering1.0
8human-trafficking1.0
9tax1.0
10customs1.1
11human-rights1.0
12forgery1.0
13foresty1.0
14environmental1.0
15illegal-logging1.1
16coastal-zone1.1
17money-counterfeiting1.0
18currency1.0
19election1.0
20banking1.0
21excise1.0
22narcotic1.0
23theft1.0
24firearm1.0
25defamation1.1
26persecution1.0
27murder1.0
28extortion1.0
29perjury1.0
30immigration1.0
31mining1.0
32pharmaceutical1.0
33cybercrime1.0
34domestic-violence1.0
35plantation1.0
36pornography1.0
37oil-gas1.0
38fishery1.0
39consumer-protection1.0
40cruise1.0
41fiduciary1.0
42copyright1.0
43food1.0
44economy1.0
45conservation1.0
46fence1.0
47obscenity1.1
48negligence1.0
49destruction1.0
50public-order1.0
51traffic1.0
52jinayah1.0
53marriage-origin1.0
54chins1.1
55children1.1
56migrant-worker1.0
57employment1.0
58broadcasting1.0
59electricity1.0
60local-government1.1
61trade-secret1.1
62education1.0
63housing1.0
64industry1.0
65military-desertion1.1
66military-obscenity1.1
67military-subordinate1.1
{% endtab %} {% tab title="Deprecated" %}
#Deprecated CategoriesNew Categories
1customcustoms
2insultdefamation
3decencyobscenity
4childchildren, chins
5governmentlocal-government
6tradetrade-secret
7militarymilitary-desertion, military-obscenity, military-subordinate
{% endtab %} {% tab title="Code" %} {% code overflow="wrap" %} ```json ["corruption", "terrorism", "national-security", "gambling", "embezzlement", "fraud", "money-laundering", "human-trafficking", "tax", "customs", "human-rights", "forgery", "foresty", "environmental", "illegal-logging", "coastal-zone", "money-counterfeiting", "currency", "election", "banking", "excise", "narcotic", "theft", "firearm", "defamation", "persecution", "murder", "extortion", "perjury", "immigration", "mining", "pharmaceutical", "cybercrime", "domestic-violence", "plantation", "pornography", "oil-gas", "fishery", "consumer-protection", "cruise", "fiduciary", "copyright", "food", "economy", "conservation", "fence", "obscenity", "negligence", "destruction", "public-order", "traffic", "jinayah", "marriage-origin", "migrant-worker", "employment", "broadcasting", "electricity", "local-government", "trade-secret", "education", "housing", "industry", "military-desertion", "military-obscenity", "military-subordinate"] ``` {% endcode %} {% endtab %} {% endtabs %} #### Risk Level | Risk | Description | | ------- | ----------------------------------------------------------------------------------------- | | high | If **match** with one or more profiles related to **Sanction**, **Watchlist**, or **SIP** | | medium | If **match** with one or more profiles related to **PEP** or **Crime** | | low | If **match** with one or more profiles related to **RCA** | | unknown | No matching profiles | #### Ongoing Screening You can set ongoing screening feature if: * You are subscribed to **transaction monitoring** * `minSimilarity` >= 0.8 * Using `birthDate` or `pseudoBirthDate` in params # Bank Account You can use the Bank Account module by defining the bankAccount that you want to check to your request. {% hint style="info" %} This module only supports Indonesian bank accounts {% endhint %} ## Endpoints | Method | URL | | ------ | ------------------------------------ | | POST | `$synapses`**/v1/account/screening** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ----------------------------------------------------------------- | -------- | --------------------------------------------------------------------------- | |

bankAccount

(required)

| `String` | Bank account number to be checked | | bankCode | `String` |

Bank code of the bank account

(ATM Bersama dan Jaringan Prima)

| | bankAccountName | `String` | Bank account holder name | | bankReportStartDate | `Date` | Get user reports history from date | | bankReportEndDate | `Date` | Get user reports history to date | | {% endtab %} | | | {% tab title="Example" %} ``` { "bankAccount": "90150041843", "bankCode": "008", "bankAccountName": "Siti Astika Nurajizah", "bankReportStartDate": "2019-09-09", "bankReportEndDate": "2021-01-01" } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ----------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | fullName | `String` | Full name of the bank account holder (based on user report) | | bankAccount | `String` | Bank account number. | | bankName | `String` | Name of the issuing bank | | bankCode | `String` | Bank code (ATM Bersama dan Jaringan Prima) | | bankRegionName | `String` | Region of the bank | | bankBranchName | `String` | Name of the bank branch | | bankBranchAddress | `String` | Address of the bank branch | | reportCount | `Integer` | The number of fraud reports related to the bank account | | reportScore |

Float

(-100 to 100)

| Accumulated total report score | | reviewCount | `Integer` | The number of reviews related to the bank account | | reviewCountSummary | `Integer` | Review rating count | | reviewScore |

Float

(-100 to 100)

| Accumulated review score | | isAccountVerified | `Boolean` | Define whether the bank account number is verified in the Kredibel system | | isBankHighRisk | `Boolean` | Define whether the bank is high risk | | isWhitelist | `Boolean` | Bank account whitelist status | | isBlacklist | `Boolean` | Bank account blacklist status | | score |

Float

(-100 to 100)

| Total accumulated credibility score of the bank account | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "Account Screening - Single.", "data": { "id": "bc07c1cb-f390-429e-9c57-8e02a12c3cc9", "score": -90.5, "status": "reject", "bankDetails": { "fullName": "Siti Astika Nurajizah", "bankAccount": "90150041843", "bankName": "Bank BTPN", "bankCode": "213", "bankRegionName": null, "bankBranchName": null, "bankBranchAddress": null, "reportCount": 13, "reportScore": -100, "reviewCount": 3, "reviewCountSummary": { "oneStars": 3, "twoStars": 0, "threeStars": 0, "fourStars": 0, "fiveStars": 0 }, "reviewScore": -7.5, "isAccountVerified": false, "isBankHighRisk": true, "isBlacklist": false, "isWhitelist": true, "score": -90.5 } } } ``` {% endtab %} {% endtabs %} # Phone Number You can use the Phone module by defining the phoneNumber that you want to check to your request. ## Endpoints | Method | URL | | ------ | ------------------------------------ | | POST | `$synapses`**/v1/account/screening** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------------------------------------------------------------- | ---- | ----------- | |

phoneNumber

(Required) | | |

| `String` | Phone number with national code (e.g. 6281234567890) | | phoneReportStartDate | `Date` | Get user reports history from date | | phoneReportEndDate | `Date` | Get user reports history to date | {% endtab %} {% tab title="Example" %} ``` { "phoneNumber": "085733756668" } ``` {% endtab %} {% endtabs %} {% hint style="info" %} If the phone number starts with 0 (not a national code), the system will automatically specify the number as the phone number from the Indonesia region. {% endhint %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ---------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | fullName | `String` | Phone number full name | | phoneNumber | `String` | Phone number | | providerName | `String` | Provider name | | providerType | `String` | Provider type (e.g. Simpati) | | countryName | `String` | Country name | | countryCode | `String` | Country code | | nationalNumber | `String` | National number | | regionName | `String` | Region name | | isPossibleNumber | `Boolean` | Return true when it's a possible number (e.g. it has the right number of digits | | isValidNumber | `Boolean` | Return true when it's a valid number (e.g. it's in an assigned exchange) | | isTrustedProvider | `Boolean` | Return true when the provider is trusted | | reportCount | `Int` | The number of fraud reports related to the phone numbers | | reportScore | `Float` | Accumulated total report score | | isWhitelist | `Boolean` | Phone number whitelist status | | isBlacklist | `Boolean` | Phone number blacklist status | | score |

Float

(-100 to 100)

| Total accumulated credibility score of the phone number | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "Account Screening - Single.", "data": { "id": "8838a65c-7a74-42e6-9c82-934338b84827", "score": -5, "status": "pass", "phoneDetails": { "fullName": null, "phoneNumber": "6285733756668", "providerName": "IM3", "providerType": null, "countryName": "Indonesia", "countryCode": null, "nationalNumber": "85733756668", "isValidNumber": true, "isTrustedProvider": false, "reportCount": 1, "reportScore": -5, "reviewCount": 0, "reviewCountSummary": { "oneStars": 0, "twoStars": 0, "threeStars": 0, "fourStars": 0, "fiveStars": 0 }, "reviewScore": 0, "isBlacklist": false, "isWhitelist": false, "score": -5 } } } ``` {% endtab %} {% endtabs %} # Email Address You can use the Email module by defining the emailAddress that you want to check to your request. ## Endpoints | Method | URL | | ------ | ------------------------------------ | | POST | `$synapses`**/v1/account/screening** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------------------------------------------------------------------ | ----------------------------------------------------------------------- | -------------------------------------------------- | |

emailAddress

(required)

|

String

(Email)

| Email address used for transaction | | verifyEmail | `Boolean` | If true, system will verify email address validity | | {% endtab %} | | | {% tab title="Example" %} ``` { "emailAddress": "contoh@gmail.com", "verifyEmail": true } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | fullName | `String` | Full name | | emailAddress | `String` | Email address | | validity |

String

\["valid", "risky", "invalid", "not\_sure"]

|

valid: Email address is exist and its safe to send mail

risky: Email address is exist but its risky to send mail

invalid: Email address not exist

not\_sure: Our system failed to verify the email address

| | isDisposable | `Boolean` | Define whether the email is disposable | | smtp.isConnected | `Boolean` | Define can we connected to the domain of the email? | | smtp.isFull | `Boolean` | Define whether the email address mailbox is full | | smtp.isDeliverable | `Boolean` | Define whether an email sent to this address is deliverable | | smtp.records | `List` | MX records of the email address | | images | `List` | Images of the email | | breaches | `List` | Is the email appear in the breach list | | isPrivateHost | `Boolean` | Return true when it's a private email address (e.g. @google.com) | | isPublicHost | `Boolean` | Return true when it’s a public email address (e.g. @gmail.com) | | isHighRiskHost | `Boolean` | Return true when it’s a high risk email host (e.g. @gmail.my.id) | | isWhitelist | `Boolean` | Define whether you have whitelisted this account number or not | | isBlacklist | `Boolean` | Define whether you have blacklisted this account number or not | | score | `Float` | Total accumulated credibility score of the Email Address | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "Account Screening - Single.", "data": { "id": "49220c90-d83d-4c12-8fbc-55527bbcf40a", "score": 0, "status": "pass", "emailDetails": { "fullName": null, "emailAddress": "contoh@gmail.com", "validity": "valid", "isDisposable": false, "smtp": { "isConnected": true, "isFull": false, "isDeliverable": true, "records": [ "alt2.gmail-smtp-in.l.google.com.", "alt1.gmail-smtp-in.l.google.com.", "gmail-smtp-in.l.google.com.", "alt3.gmail-smtp-in.l.google.com.", "alt4.gmail-smtp-in.l.google.com." ] }, "images": [], "breaches": [ { "name": "Bukalapak" }, { "name": "Cit0day" }, { "name": "Collection1" }, { "name": "Dailymotion" }, { "name": "Dropbox" }, { "name": "Edmodo" }, { "name": "Leet" }, { "name": "Lifeboat" }, { "name": "Nitro" }, { "name": "ShopBack" }, { "name": "Tamodo" }, { "name": "Tokopedia" }, { "name": "Wattpad" } ], "isBreached": true, "isPrivateHost": false, "isPublicHost": true, "isHighRiskHost": false, "isBlacklist": false, "isWhitelist": false, "score": 0 } } } ``` {% endtab %} {% endtabs %} # IP Address You can use the IP module by defining the ipAddress that you want to check to your JSON request. ## Endpoints | Method | URL | | ------ | ------------------------------------ | | POST | `$synapses`**/v1/account/screening** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | --------------------------------------------- | ----------------------------------------------------------------------------- | ---------------------------- | |

ipAddress

required

|

String

(IPv4 format)

| IP address you want to check | | {% endtab %} | | | {% tab title="Example" %} ``` { "ipAddress": "159.253.145.183" } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------------------ | ------------- | ------------------------------------------------------------------------- | | as | `String` | Autonomous system number and organization, separated by space (RIR). | | asname | `String` | Autonomous system name (RIR). | | city | `String` | City name. | | continent | `String` | Continent name. | | continentCode | `String` | Two-character continent code. | | country | `String` | Country name. | | countryCode | `String` | Two-letter country code ISO 3166-1 alpha-2. | | currency | `String` | National currency. | | district | `String` | District name. | | isp | `String` | ISP name. | | lat | `Float` | Latitude. | | lon | `Float` | Longitude. | | org | `String` | Organization name. | | regionName | `String` | Region name. | | timezone | `String` | Time zone. | | zip | `String` | Zip code. | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "Account Screening - Single.", "data": { "id": "28b78927-8546-45fd-ba9f-17239bf366a9", "score": -15, "status": "review", "ipDetails": { "ipAddress": "159.253.145.183", "as": "AS36351 SoftLayer Technologies Inc.", "asname": "SOFTLAYER", "city": "Amsterdam", "continent": "Europe", "continentCode": "EU", "country": "Netherlands", "countryCode": "NL", "currency": "EUR", "district": "", "isp": "SoftLayer", "lat": 52.3759, "org": "Hosting Services Inc. (dba Midphase)", "region": "NH", "regionName": "North Holland", "timezone": "Europe/Amsterdam", "zip": "1012", "isProxy": true, "isMobile": false, "isHosting": true, "isWhitelist": false, "isBlacklist": true, "score": -15 } } } ``` {% endtab %} {% endtabs %} # Electronic Certificate # Certificate Issuance The Electronic Certificate Issuance Service is the activity of identity checking that shows legal subjects in order to issue an Electronic Certificate with the purpose of doing verification of citizen {% hint style="info" %} This module only support verification for indonesian identity card (KTP) {% endhint %} ## {% embed url="" %} ## Endpoints | Method | URL | | ------ | ----------------------------------------- | | POST | `$synapses`**`/v1/certificate/issuance`** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ---------------------------------------------------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------- | |

identityId

(required)

|

String
(len: 16)

| Nomor induk kependudukan (NIK) based on the identity card. | |

fullName

(required) | | |

| `String` | Full name based on the identity card. | |

birthDate
(required)

|

String
(format: yyyy-mm-dd)

| Birth Date based on the identity card. | |

emailAddress
(required)

| `String` | Email address (must be unique per NIK). | |

phoneNumber
(required)

| `String` | Valid phone number, use country code but without symbol (+), (must be unique per nik). | |

faceImage

(required)

| `Base64` |

Selfie photo of the identity card holder.

Image binary encoded in base64 without <data:image/png;>.
- Supports: JPG, JPEG, PNG, SVG
- Min Size: 100KB
- Max Size: 4MB
- Min Pixel: 480px x 640px

| |

identityImage

(required)

| `Base64` |

Identity card photo.

Image binary encoded in base64 without <data:image/png;>.
- Supports: JPG, JPEG, PNG, SVG
- Min Size: 100KB
- Max Size: 2MB
- Min Pixel: 480px x 360px

| {% endtab %} {% tab title="Example" %} ``` { "identityId": "1234567890123456", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` {% endtab %} {% endtabs %} #### **Testing** {% hint style="info" %} In the sandbox environment, we only response api call with dummy data. To get valid response data, you can use our production environment instead. {% endhint %} {% tabs %} {% tab title="All Match" %} You can use any identityId to produce verified status. **Example:** ``` { "identityId": "1234567890123456", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` ``` { "message": "Certificate electronic verification has been done", "data": { "id": "8c4d6927-b4e1-428b-b95f-c21b6734b73f", "status": "verified", "rejectFields": [], "referenceId": "ref_certel#e87c8bc2-5d10-455b-98a0-187d60f72873" } } ``` {% endtab %} {% tab title="Invalid NIK" %} You can use identityId =`1234567890111111` to produce invalid identityId. **Example:** ``` { "identityId": "1234567890111111", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` ``` { "message": "Certificate electronic verification has been done", "data": { "id": "93db29c0-ca66-4803-aa70-537439c9cfff", "status": "not_verified", "rejectFields": [ "identityId" ], "referenceId": "ref_certel#3c42fa6b-c2c9-4705-8117-cf9d08c8d2aa" } } ``` {% endtab %} {% tab title="Invalid Name" %} You can use identityId =`1234567890111112` to produce invalid fullName. **Example:** ``` { "identityId": "1234567890111112", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` ``` { "message": "Certificate electronic verification has been done", "data": { "id": "716ccf7d-4620-4146-b889-8c660cc8f280", "status": "not_verified", "rejectFields": [ "fullName" ], "referenceId": "ref_certel#8c679bd3-087b-49f7-bdd6-3f5c6300a927" } } ``` {% endtab %} {% tab title="Invalid Birth Date" %} You can use identityId=`1234567890111113` to produce invalid birthDate. **Example:** ``` { "identityId": "1234567890111113", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` ``` { "message": "Certificate electronic verification has been done", "data": { "id": "bba69765-371c-45ac-b673-4bb36f07ab9c", "status": "not_verified", "rejectFields": [ "birthDate" ], "referenceId": "ref_certel#763f7342-66f6-47eb-87d2-e9a11378d911" } } ``` {% endtab %} {% tab title="Invalid Face Image" %} You can use identityId=`1234567890111114` to produce invalid face image. **Example:** ``` { "identityId": "1234567890111114", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` ``` { "message": "Certificate electronic verification has been done", "data": { "id": "a940e1e9-22f0-4154-8b0f-6219b417a6b1", "status": "not_verified", "rejectFields": [ "faceImage" ], "referenceId": "ref_certel#8c946fc0-5ac2-4120-9ee5-415baf0b0e3a" } } ``` {% endtab %} {% tab title="Invalid Identity Image" %} You can use identityId=`1234567890111115` to produce invalid identityImage. **Example:** ``` { "identityId": "1234567890111115", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` ``` { "message": "Certificate electronic verification has been done", "data": { "id": "3e37f95d-a1e8-4d89-8f0c-0f267ea0a36a", "status": "not_verified", "rejectFields": [ "identityImage" ], "referenceId": "ref_certel#8c946fc0-5ac2-4120-9ee5-415baf0b0e2s" } } ``` {% endtab %} {% tab title="Invalid Email Address" %} {% hint style="info" %} It means that the email, phone number, or both have been used by another NIK (identification number). {% endhint %} You can use identityId=`1234567890111116` to produce invalid emailAddress. **Example:** ``` { "identityId": "1234567890111116", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` ``` { "message": "Certificate electronic verification has been done", "data": { "id": "368fea8e-0fad-4bc3-8ef6-fa2d8585d1d7", "status": "verified_with_reason", "rejectFields": [ "emailAddress" ], "referenceId": "ref_certel#dfb8b449-4d83-41e8-b2f4-0343ead765f4" } } ``` {% endtab %} {% tab title="Invalid Phone Number" %} {% hint style="info" %} It means that the email, phone number, or both have been used by another NIK (identification number). {% endhint %} You can use identityId=`1234567890111117` to produce invalid phoneNumber. **Example:** ``` { "identityId": "1234567890111117", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` ``` { "message": "Certificate electronic verification has been done", "data": { "id": "a67c4ab8-c723-49f1-a2a8-e7a579df94f7", "status": "verified_with_reason", "rejectFields": [ "phoneNumber" ], "referenceId": "ref_certel#a704a3ad-1986-4897-975e-16e015d88b2e" } } ``` {% endtab %} {% tab title="Invalid Email Address & Phone Number" %} {% hint style="info" %} It means that the email, phone number, or both have been used by another NIK (identification number). {% endhint %} You can use identityId=`1234567890111118` to produce invalid Email Address & phoneNumber. **Example:** ``` { "identityId": "1234567890111118", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` ``` { "message": "Certificate electronic verification has been done", "data": { "id": "d35484cc-7f49-4d23-8fdd-3052fd96c8b6", "status": "verified_with_reason", "rejectFields": [ "phoneNumber", "emailAddress" ], "referenceId": "ref_certel#3c42fa6b-c2c9-4705-8117-cf9d08c8d2aa" } } ``` {% endtab %} {% tab title="Liveness Error" %} {% hint style="info" %} Failed because of liveness check, only liveness will be charged {% endhint %} You can use identityId=`1234567890111119` to produce liveness error. **Example:** ``` { "identityId": "1234567890111119", "fullName": "ASEP SUPRIYADI", "birthDate": "1990-07-06", "emailAddress": "test@email.com", "phoneNumber": "621234567890", "faceImage": "", "identityImage": "" } ``` ``` { "message": "Certificate electronic verification has been done", "data": { "id": "36a6ed7b-cd7a-44d7-b4d2-d181cf561ea3", "status": "not_verified", "rejectFields": [ "liveness_check" ], "referenceId": "ref_certel#3c42fa6b-c2c9-4705-8117-cf9d08c8d2aa" } } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------------ | -------- | ------------------------------------------------------------------------------------------------------------------ | | id | `String` | Kredibel history id (unique for every transactions). | | status | `String` |

Identifier of the transaction status:

- verified

- verified\_with\_reason

- not\_verified

| | rejectFields | `Array` | Indicator if there’s a false response to a or any parameter, example if nik. | | referenceId | `String` | Reference id. | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "Certificate electronic verification has been done", "data": { "id": "8c4d6927-b4e1-428b-b95f-c21b6734b73f", "status": "verified", "rejectFields": [], "referenceId": "ref_certel#e87c8bc2-5d10-455b-98a0-187d60f72873" } } ``` {% endtab %} {% endtabs %} ### **Errors** {% hint style="info" %} Please read this [page \](/responses-and-errors) to know more about response. {% endhint %} # Identity Verification \[Deprecated] This service allows you to verify national identity card (KTP) data against government databases. ## Endpoints | Method | Url | Description | | ------ | ----------------------------------------------------- | ----------------------- | | POST | `$synapses`**`/v1/identity/verification/demography`** | Demography verification | | POST | `$synapses`**`/v1/identity/verification/biometric`** | Biometric verification | | POST | `$synapses`**`/v1/identity/verification/full`** | Full verification | # Biometric Verification Face biometric verification to dukcapil database. {% hint style="info" %} This module only support biometric verification for indonesian identity card (KTP) {% endhint %} ![](/files/4MXbZc0nryTfyYByi1TW) ## Endpoints | Method | URL | | ------ | ---------------------------------------------------- | | POST | `$synapses`**`/v1/identity/verification/biometric`** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ---------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------- | |

identityId

(required)

|

String
(len: 16)

| Nomor induk kependudukan (NIK). | |

faceImage

(required) | | |

| `Base64` |

Image binary encoded in base64 without <data:image/png;>.
- Supports: JPG, JPEG, PNG, SVG
- Max Size: 1MB

| {% endtab %} {% tab title="Example" %} ``` { "identityId": "1234567890123456", "faceImage": "" } ``` {% endtab %} {% endtabs %} #### **Testing** {% hint style="info" %} In the sandbox environment, we only response api call with dummy data. To get valid response data, you can use our production environment instead. {% endhint %} {% tabs %} {% tab title="Face Match" %} You can use identityId = `1234567890123456` to produce face not match result. **Example:** ``` { "identityId": "1234567890123456", "faceImage": "" } ``` ``` { "message": "Identity biometric verification succeeded.", "data": { "id": "64d07984-81a8-4e79-ad16-a439f5885075", "identityId": "1234567890123456", "isValid": true, "isActive": true, "response": { "face": true, "faceSimilarity": 1.0 } } } ``` {% endtab %} {% tab title="Face Not Match" %} You can use any identityId except `1234567890123456` to produce face not match result. **Example:** ``` { "identityId": "1234567890111111", "faceImage": "" } ``` ``` { "message": "Identity biometric verification succeeded.", "data": { "id": "cfe1732d-bd89-4e97-94c1-b3790a2952c4", "identityId": "1234567890111111", "isValid": true, "isActive": true, "response": { "face": false, "faceSimilarity": 0.24 } } } ``` {% endtab %} {% tab title="Wrong Identity" %} You can use any identityId except `1234567890123456` and `1234567890111111` to produce identity not valid result. ``` { "identityId": "1234567890123444", "faceImage": "" } ``` ``` { "message": "Identity biometric verification succeeded.", "data": { "id": "f989eae0-59a3-4a04-baac-6f16c8e7b7fd", "identityId": "1234567890123444", "isValid": false, "isActive": false, "response": {} } } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ---------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | id | `String` | Unique identifier. | | identityId | `String` | Nomor induk kependudukan (NIK). | | isValid | `Boolean` | Return true if identityId is **exist** in the Dukcapil database. | | isActive | `Boolean` | Return true if identityId is **active** in the Dukcapil database. | | response:face | `Boolean` |

Return true if input face match with the face in dukcapil database.
- Default threshold: >= 0.75: True

| | response:faceSimilarity |

Float
(0-1)

| Similarity between the input face and the face in Dukcapil database. | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "Identity biometric verification succeeded.", "data": { "id": "7d7cb73b-c55a-4e93-b3d0-972058bd9ccd", "identityId": "1234567890123456", "isValid": false, "isActive": false, "response": { "face": false, "faceSimilarity": 0.36 } } } ``` {% endtab %} {% endtabs %} ### **Errors** {% hint style="info" %} Please read this [page \](/responses-and-errors) to know more about response. {% endhint %} **Error 4XX** {% tabs %} {% tab title="Error Type" %} | Error Type | Description | Is charged? | | ------------------------- | ----------------------------------------------------------------------- | ----------- | | invalid\_base64\_encoding | Invalid base64 encoding. | False | | image\_too\_large | Input image is greater than the maximum size allowed. | False | | no\_face\_detected | No face was detected from the input image or the input image is blurry. | True | | request\_error | Cannot get response from Dukcapil server. | False | | {% endtab %} | | | {% tab title="Structure" %} ``` { "errors":{ "errorId": , "errorType": }, "message": } ``` {% endtab %} {% endtabs %} **Error 5XX** **F**or every 5XX http code response, there will be no charge. # Demography Verification Demography verification to dukcapil database. {% hint style="info" %} This module only support biometric verification for indonesian identity card (KTP) {% endhint %} ![](/files/2ruXJEYyi11wQ4BHSaRZ) ## Endpoints | Method | URL | | ------ | ----------------------------------------------------- | | POST | `$synapses`**`/v1/identity/verification/demography`** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ---------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------- | |

identityId

(required)

|

String
(len: 16)

| Nomor induk kependudukan (NIK). | |

fullName

(optional) | | |

| `String` | Full name. | |

birthPlace
(optional)

| `String` | Birth Place. | |

birthDate
(optional)

|

String
(format: yyyy-mm-dd)

| Birth Date. | |

address
(optional)

| `String` | Address. | |

threshold
(optional)

|

Float
(0-1)

|

Matched threshold for demography data (fullName, birthPlace, address)
- 0=0% match, 0.5=50% match, 1=100% match

| {% endtab %} {% tab title="Example" %} ``` { "identityId": "1234567890123456", "faceImage": "" } ``` {% endtab %} {% endtabs %} #### **Testing** {% hint style="info" %} In the sandbox environment, we only response api call with dummy data. To get valid response data, you can use our production environment instead. {% endhint %} {% tabs %} {% tab title="All Match" %} You can use identityId = `1234567890123456` to produce face not match result. **Example:** ``` { "identityId": "1234567890123456", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06" } ``` ``` { "message": "Identity demography verification succeeded.", "data": { "id": "43ad6108-a5ce-452f-8603-d60d24c2ef3e", "identityId": "1234567890123456", "isValid": true, "isActive": true, "response": { "fullName": true, "fullNameSimilarity": 1.0, "address": true, "addressSimilarity": 1.0, "birthPlace": true, "birthPlaceSimilarity": 1.0, "birthDate": true } } } ``` {% endtab %} {% tab title="Wrong Identity" %} You can use any identityId except `1234567890123456` to produce identity not valid result. **Example:** ``` { "identityId": "1234567890123450", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06" } ``` ``` { "message": "Identity demography verification succeeded.", "data": { "id": "c1fa0289-b6ea-4ffe-9d05-10fd99143ad5", "identityId": "1234567890123450", "isValid": false, "isActive": false, "response": {} } } ``` {% endtab %} {% tab title="Wrong Name" %} You can use identityId=`1234567890123451` to produce full name is not valid. **Example:** ``` { "identityId": "1234567890123451", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06" } ``` ``` { "message": "Identity demography verification succeeded.", "data": { "id": "673a9284-87e9-4f08-bb08-b820844b6159", "identityId": "1234567890123451", "isValid": true, "isActive": true, "response": { "fullName": false, "fullNameSimilarity": 0.43, "address": true, "addressSimilarity": 1.0, "birthPlace": true, "birthPlaceSimilarity": 1.0, "birthDate": true } } } ``` {% endtab %} {% tab title="Wrong Address" %} You can use identityId=`234567890123452` to produce address is not valid. **Example:** ``` { "identityId": "1234567890123452", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06" } ``` ``` { "message": "Identity demography verification succeeded.", "data": { "id": "be99966d-597c-4da9-a475-83392ef899f4", "identityId": "1234567890123452", "isValid": true, "isActive": true, "response": { "fullName": true, "fullNameSimilarity": 1.0, "address": false, "addressSimilarity": 0.58, "birthPlace": true, "birthPlaceSimilarity": 1.0, "birthDate": true } } } ``` {% endtab %} {% tab title="Wrong Birthplace" %} You can use identityId=`234567890123453` to produce birth place is not valid. **Example:** ``` { "identityId": "1234567890123453", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06" } ``` ``` { "message": "Identity demography verification succeeded.", "data": { "id": "4faf35f4-44a1-47b2-8a18-07d243174aba", "identityId": "1234567890123453", "isValid": true, "isActive": true, "response": { "fullName": true, "fullNameSimilarity": 1.0, "address": true, "addressSimilarity": 1.0, "birthPlace": false, "birthPlaceSimilarity": 0.23, "birthDate": true } } } ``` {% endtab %} {% tab title="Wrong Birthdate" %} You can use identityId=`234567890123454` to produce birth date is not valid. **Example:** ``` { "identityId": "1234567890123454", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06" } ``` ``` { "message": "Identity demography verification succeeded.", "data": { "id": "41272ecf-b5e2-4897-a492-b89356fab0c2", "identityId": "1234567890123454", "isValid": true, "isActive": true, "response": { "fullName": true, "fullNameSimilarity": 1.0, "address": true, "addressSimilarity": 1.0, "birthPlace": true, "birthPlaceSimilarity": 1.0, "birthDate": false } } } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ----------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------------------------- | | id | `String` | Unique identifier. | | identityId | `String` | Nomor induk kependudukan (NIK). | | isValid | `Boolean` | Return true if identityId is **exist** in the Dukcapil database. | | isActive | `Boolean` | Return true if identityId is **active** in the Dukcapil database. | | response:fullName | `Boolean` | Return true if input fullName match with the fullName in Dukcapil database. | | response:fullNameSimilarity |

Float
(0-1)

| Similarity between the input fullName and the fullName in Dukcapil database. | | response:address | `Boolean` | Return true if input birth date match with the birth date in Dukcapil database. | | response:addressSimilarity |

Float
(0-1)

| Similarity between the input address and the address in Dukcapil database. | | response:birthPlace | `Boolean` | Return true if input birth place match with the birth place in Dukcapil database. | | response:birthPlaceSimilarity |

Float
(0-1)

| Similarity between the input birthPlace and the birthPlace in Dukcapil database. | | response:birthDate | `Boolean` | Return true if input birth date match with the birth date in Dukcapil database. | {% endtab %} {% tab title="Example" %} ``` { "message": "Identity demography verification succeeded.", "data": { "id": "948cc6f9-1662-4ae7-a578-fdaa50331507", "identityId": "1234567890123456", "isValid": true, "isActive": true, "response": { "fullName": true, "fullNameSimilarity": 1.0, "address": true, "addressSimilarity": 1.0, "birthPlace": true, "birthPlaceSimilarity": 1.0, "birthDate": true } } } ``` {% endtab %} {% endtabs %} ### **Errors** {% hint style="info" %} Please read this [page \](/responses-and-errors) to know more about response. {% endhint %} **Error 4XX** {% tabs %} {% tab title="Error Type" %} | Error Type | Description | Is charged? | | -------------- | ----------------------------------------- | ----------- | | request\_error | Cannot get response from Dukcapil server. | False | | {% endtab %} | | | {% tab title="Structure" %} In general, the error response structure is as below**:** ``` { "errors":{ "errorId": , "errorType": }, "message": } ``` {% endtab %} {% endtabs %} **Error 5XX** **F**or every 5XX http code response, there will be no charge. # Full Verification Demography and Biometric verification to dukcapil database. {% hint style="info" %} This module only support verification for indonesian identity card (KTP) {% endhint %} ![](/files/zjmMYHJD3aDRx94DxOZE) ## Endpoints | Method | URL | | ------ | ----------------------------------------------- | | POST | `$synapses`**`/v1/identity/verification/full`** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ---------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------- | |

identityId

(required)

|

String
(len: 16)

| Nomor induk kependudukan (NIK). | |

fullName

(required) | | |

| `String` | Full name. | |

birthPlace
(required)

| `String` | Birth Place. | |

birthDate
(required)

|

String
(format: yyyy-mm-dd)

| Birth Date. | |

address
(required)

| `String` | Address. | |

faceImage

(required)

| `Base64` |

Image binary encoded in base64 without <data:image/png;>.
- Supports: JPG, JPEG, PNG, SVG
- Max Size: 1MB

| |

threshold
(optional)

|

Float
(0-1)

|

Matched threshold for demography data (fullName, birthPlace, address)
- 0=0% match, 0.5=50% match, 1=100% match

| |

faceThreshold
(optional)

| **(0-1)** |

Matched threshold for biometric data (face)
- 0=0% match, 0.5=50% match, 1=100% match

| {% endtab %} {% tab title="Example" %} ``` { "identityId": "1234567890123456", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06", "faceImage": "" } ``` {% endtab %} {% endtabs %} #### **Testing** {% hint style="info" %} In the sandbox environment, we only response api call with dummy data. To get valid response data, you can use our production environment instead. {% endhint %} {% tabs %} {% tab title="All Match" %} You can use identityId=`1234567890123456` to produce all-match result. **Example:** ``` { "identityId": "1234567890123456", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06", "faceImage": "" } ``` ``` { "message": "Identity full verification succeeded.", "data": { "id": "57746ec6-8b36-404c-890f-8a683f2372ef", "identityId": "1234567890123456", "isValid": true, "isActive": true, "response": { "fullName": true, "fullNameSimilarity": 1.0, "address": true, "addressSimilarity": 1.0, "birthPlace": true, "birthPlaceSimilarity": 1.0, "birthDate": true, "face": true, "face_similarity": 1.0 } } } ``` {% endtab %} {% tab title="Wrong Identity" %} You can use any identityId except `1234567890123456` to produce identity not valid result. **Example:** ``` { "identityId": "1234567890123450", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06", "faceImage": "" } ``` ``` { "message": "Identity full verification succeeded.", "data": { "id": "f9f66616-12f0-402f-93bf-5b7f165ab23d", "identityId": "1234567890123450", "isValid": false, "isActive": false, "response": {} } } ``` {% endtab %} {% tab title="Wrong Name" %} You can use identityId =`1234567890123451` to produce full name is not valid. **Example:** ``` { "identityId": "1234567890123451", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06", "faceImage": "" } ``` ``` { "message": "Identity full verification succeeded.", "data": { "id": "df25614d-dce8-436e-9318-b3ac9bbda179", "identityId": "1234567890123451", "isValid": true, "isActive": true, "response": { "fullName": false, "fullNameSimilarity": 0.43, "address": true, "addressSimilarity": 1.0, "birthPlace": true, "birthPlaceSimilarity": 1.0, "birthDate": true, "face": false, "face_similarity": 0.12 } } } ``` {% endtab %} {% tab title="Wrong Address" %} You can use identityId=`234567890123452` to produce address is not valid. **Example:** ``` { "identityId": "1234567890123452", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06", "faceImage": "" } ``` ``` { "message": "Identity full verification succeeded.", "data": { "id": "b26ebc48-20fa-4f53-8bb4-652058def9b0", "identityId": "1234567890123452", "isValid": true, "isActive": true, "response": { "fullName": true, "fullNameSimilarity": 1.0, "address": true, "addressSimilarity": 0.58, "birthPlace": true, "birthPlaceSimilarity": 1.0, "birthDate": true, "face": false, "face_similarity": 0.73 } } } ``` {% endtab %} {% tab title="Wrong Birthplace" %} You can use identityId=`234567890123453` to produce birth place is not valid. **Example:** ``` { "identityId": "1234567890123453", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06", "faceImage": "" } ``` ``` { "message": "Identity full verification succeeded.", "data": { "id": "6fbf106c-ad7e-4371-8571-3e9615a9590d", "identityId": "1234567890123453", "isValid": true, "isActive": true, "response": { "fullName": true, "fullNameSimilarity": 1.0, "address": true, "addressSimilarity": 1.0, "birthPlace": false, "birthPlaceSimilarity": 0.23, "birthDate": true, "face": false, "face_similarity": 0.65 } } } ``` {% endtab %} {% tab title="Wrong Birthdate" %} You can use identityId=`234567890123454` to produce birth date is not valid. **Example:** ``` { "identityId": "1234567890123454", "fullName": "ASEP SUPRIYADI", "address": "JL SESAMA NO 123", "birthPlace": "JAKARTA", "birthDate": "1990-07-06", "faceImage": "" } ``` ``` { "message": "Identity full verification succeeded.", "data": { "id": "84ede311-7eb7-462b-80ae-0795fafcf368", "identityId": "1234567890123454", "isValid": true, "isActive": true, "response": { "fullName": true, "fullNameSimilarity": 1.0, "address": true, "addressSimilarity": 1.0, "birthPlace": true, "birthPlaceSimilarity": 1.0, "birthDate": true, "face": false, "face_similarity": 0.46 } } } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ----------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | id | `String` | Unique identifier. | | identityId | `String` | Nomor induk kependudukan (NIK). | | isValid | `Boolean` | Return true if identityId is **exist** in the Dukcapil database. | | isActive | `Boolean` | Return true if identityId is **active** in the Dukcapil database. | | response:fullName | `Boolean` | Return true if input fullName match with the fullName in Dukcapil database. | | response:fullNameSimilarity |

Float
(0-1)

| Similarity between the input fullName and the fullName in Dukcapil database. | | response:address | `Boolean` | Return true if input birth date match with the birth date in Dukcapil database. | | response:addressSimilarity |

Float
(0-1)

| Similarity between the input address and the address in Dukcapil database. | | response:birthPlace | `Boolean` | Return true if input birth place match with the birth place in Dukcapil database. | | response:birthPlaceSimilarity |

Float
(0-1)

| Similarity between the input birthPlace and the birthPlace in Dukcapil database. | | response:birthDate | `Boolean` | Return true if input birth date match with the birth date in Dukcapil database. | | response:face | `Boolean` |

Return true if input face match with the face in dukcapil database.
- Default threshold: >= 0.75: True

| | response:faceSimilarity |

Float
(0-1)

|

Similarity between the input face and the face in Dukcapil database.
- Default threshold: >= 0.8: True

| {% endtab %} {% tab title="Example" %} ``` { "message": "Identity full verification succeeded.", "data": { "id": "68224a77-60f4-40f6-85ff-35801f4d6541", "identityId": "1234567890123451", "isValid": true, "isActive": true, "response": { "fullName": false, "fullNameSimilarity": 0.43, "address": true, "addressSimilarity": 1.0, "birthPlace": true, "birthPlaceSimilarity": 1.0, "birthDate": true, "face": true, "faceSimilarity": 0.81 } } } ``` {% endtab %} {% endtabs %} ### **Errors** {% hint style="info" %} Please read this [page \](/responses-and-errors) to know more about response. {% endhint %} **Error 4XX** {% tabs %} {% tab title="Error Type" %} | Error Type | Description | Is charged? | | ------------------------- | ----------------------------------------------------------------------- | ----------- | | invalid\_base64\_encoding | Invalid base64 encoding. | False | | image\_too\_large | Input image is greater than the maximum size allowed. | False | | no\_face\_detected | No face was detected from the input image or the input image is blurry. | True | | request\_error | Cannot get response from Dukcapil server. | False | | {% endtab %} | | | {% tab title="Structure" %} ``` { "errors":{ "errorId": , "errorType": }, "message": } ``` {% endtab %} {% endtabs %} **Error 5XX** **F**or every 5XX http code response, there will be no charge. # Text Recognition ## Introduction Text Recognition can help you to automate tedious data entry and speed up the onboarding process. ## Ability * Recognize text in all orientations * Detect identity card in the image ## Limitations The following is a list of conditions that can reduce performance of the model to recognize text. * Blurry Image * Glare Image * Lightning * Perspective ## Under the Hood Kredibel is using **deep learning** to perform text recognition task. Below is an explanation of how a Kredibel Text Recognition system works. ### 1. Upload Image Users can upload a **handheld** or **non-handheld** identity card image. Our system can handle both. ### 2. Identity Card Detection Our system will **detect** whether there is an identity card in the image or not. ### 3. Cropping Our system will automatically **crop** the image region of interest (identity card) to prevent unwanted characters from being detected. ### 4. Orientation estimation Our system will **estimate** text orientation and **normalize** it. Thats why our system can recognize text in all orientations. ### 5. Text Detection Our system **detects** text on the image. Create a bounding box for each detected word. ### 6. Text Recognition Our system **recognizes** each text detected by the text detection model. ### 7. POST-OCR Parsing Our system will **parse** the unstructured data generated by the OCR system into structured data. ## Endpoints | Method | URL | Description | | ------ | ---------------------------- | ------------ | | POST | `$vision/v1/ocr/id/ktp` | KTP OCR | | POST | `$vision/v1/ocr/id/sim` | SIM OCR | | POST | `$vision/v1/ocr/id/passport` | Passport OCR | # National Identity Text recognition on Indonesian Identity Card (KTP). {% hint style="info" %} This endpoint only supports Indonesian identity cards (KTP) {% endhint %} {% embed url="" %} ## Endpoints | Method | URL | | ------ | ----------------------------- | | POST | `$vision`**`/v1/ocr/id/ktp`** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% hint style="info" %} The OCR inference time may vary. It depends on many factors, one of them is the **image size**. We recommend you to **resize** the image before sending it to Kredibel system. {% endhint %} {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ----------------------------------------------------------- | ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

image

(Required)

| \ |

Image binary encoded in base64 without \.
- Supports: JPG, JPEG, PNG
- Max Size: 2MB
- Recommended size: 1024x768

| | cardDetect |

Boolean

(Default: true)

| Use card detection model | | passCardDetect |

Boolean

(Default: true)

| If `false`, when identity card is not detected on the image it will return an **error message** | | flipImage |

Boolean

(Default: false)

| If `true`, the system will flip your image | | checkFlipImage |

Boolean

(Default: false)

| If `true`, the system will check whether your image is flipped or not | | validateResult |

Boolean

(Default: false)

| If `true`, you will get format validation information about result. | | {% endtab %} | | | {% tab title="Example (Recommendation)" %} You just need to declare image field in order to use this service. ``` { "image": "/9j/..." } ``` {% endtab %} {% tab title="Example (Verbose)" %} ``` { "image": "string", "cardDetect": true, "passCardDetect": true, "flipImage": true, "checkFlipImage": true, "validateResult": true } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} `result` | Field | Type | Description | | ------------- | -------------------------------------------------------------------------- | ----------------- | | identityId | `String` | Identity id (NIK) | | fullName | `String` | Full name | | birthPlace | `String` | Place of birth | | birthDate |

Date

(dd-mm-yyyy)

| Date of birth | | gender | `String` | Gender | | address | `String` | Address | | province | `String` | Province | | city | `String` | City | | district | `String` | District | | village | `String` | Village | | rtrw | `String` | RT/RW | | religion | `String` | Religion | | maritalStatus | `String` | Marital status | | occupation | `String` | Occupation | | nationality | `String` | Nationality | `information`
FieldTypeDescription
tiltFloatTilt degree (0-360) on identity card. If it is upside-down, then the value is 180.
cardDetectedBooleanReturn true if out system detected identity card on the image.
{% endtab %} {% tab title="Example" %} ``` { "message": "string", "data": { "id": "string", "result": { "identityId": "string", "fullName": "string", "birthPlace": "string", "birthDate": "string", "gender": "string", "address": "string", "province": "string", "city": "string", "district": "string", "village": "string", "rtrw": "string", "religion": "string", "maritalStatus": "string", "occupation": "string", "nationality": "string" }, "information": { "tilt": float, "cardDetected": boolean } } } ``` {% endtab %} {% endtabs %} ### **Errors** {% hint style="info" %} Please read this [page \](/responses-and-errors) to know more about response. {% endhint %} **Error 4XX** {% tabs %} {% tab title="Error Type" %}
Error TypeDescriptionIs charged?
invalid_base64_encodingInvalid base64 encoding.false
card_not_foundThere is no identity card found in the image. This error only raised if you set passCardDetect = False.true
text_not_foundThere is no text found in the image.true
invalid_document_typeThe document sent does not appear to be the right identity type.true
parsing_failedSystem fail to parse identity card.true
{% endtab %} {% tab title="Structure" %} In general, the error response structure is as below**:** ``` { "errors":{ "errorId": , "errorType": }, "message": } ``` {% endtab %} {% endtabs %} **Error 5XX** **F**or every 5XX http code response, there will be no charge. # Driver License Text recognition on Indonesian driver's license (SIM). {% hint style="info" %} This service only supports Indonesian driver's license (SIM) {% endhint %} ## Endpoints | Method | URL | | ------ | ----------------------------- | | POST | `$vision`**`/v1/ocr/id/sim`** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% hint style="info" %} The OCR inference time may vary. It depends on many factors, one of them is the **image size**. We recommend you to **resize** the image before sending it to Kredibel system. {% endhint %} {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

image

(Required)

| `` |

Image binary encoded in base64 without \.
- Supports: JPG, JPEG, PNG
- Max Size: 2MB
- Recommended size: 1024x768

| | cardDetect |

Boolean

(Default: true)

| Use card detection model | | passCardDetect |

Boolean

(Default: true)

| If `false`, when identity card is not detected on the image it will return an **error message** | | flipImage |

Boolean

(Default: false)

| If `true`, the system will flip your image | | checkFlipImage |

Boolean

(Default: false)

| If `true`, the system will check whether your image is flipped or not | | {% endtab %} | | | {% tab title="Example (Recommendation)" %} You just need to declare image field in order to use this service. ``` { "image": "/9j/..." } ``` {% endtab %} {% tab title="Example (Verbose)" %} ``` { "image": "string", "cardDetect": true, "passCardDetect": true, "flipImage": true, "checkFlipImage": true } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} `result` | Field | Type | Description | | ---------- | ----------------------------------------------------------------------------------- | -------------- | | identityId | `String` | Identity id | | fullName | `String` | Full name | | birthPlace | `String` | Place of birth | | birthDate |

Date

(dd-mm-yyyy)

| Date of birth | | gender |

String

\["PRIA", "WANITA"]

| Gender | | address | `String` | Address | | occupation | `String` | Occupation | | expiryDate |

Date

(dd-mm-yyyy)

| Expiry date | `information` | Field | Type | Description | | ------------ | ------- | ---------------------------------------------------------------------------------- | | tilt | `Float` | Tilt degree (0-360) on identity card. If it is upside-down, then the value is 180. | | cardDetected | Boolean | Return true if out system detected identity card on the image. | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "string", "data": { "id": "string", "result": { "identityId": "string", "indicator": "string", "country": "string", "countryCode": "string", "fullName": "string", "nationality": "string", "nationalityCode": "string", "birthDate": "string", "sex": "string", "personalNumber": "string", "expirationDate": "string" }, "information": { "tilt": float, "cardDetected": boolean } } } ``` {% endtab %} {% endtabs %} ### **Errors** {% hint style="info" %} Please read this [page \](/responses-and-errors) to know more about response. {% endhint %} **Error 4XX** {% tabs %} {% tab title="Error Type" %}
Error TypeDescriptionIs charged?
invalid_base64_encodingInvalid base64 encoding.false
card_not_foundThere is no identity card found in the image. This error only raised if you set passCardDetect = False.true
text_not_foundThere is no text found in the image.true
invalid_document_typeThe document sent does not appear to be the right identity type.true
parsing_failedSystem fail to parse identity card.true
{% endtab %} {% tab title="Structure" %} ``` { "errors":{ "errorId": , "errorType": }, "message": } ``` {% endtab %} {% endtabs %} **Error 5XX** **F**or every 5XX http code response, there will be no charge. # Passport Text recognition on Passport. {% hint style="info" %} This service supports almost **all type** of passports from around the world {% endhint %} ## Endpoints | Method | URL | | ------ | ---------------------------------- | | POST | `$vision`**`/v1/ocr/id/passport`** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Request** {% hint style="info" %} The OCR inference time may vary. It depends on many factors, one of them is the **image size**. We recommend you to **resize** the image before sending it to Kredibel system. {% endhint %} {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ----------------------------------------------------------- | -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |

image

(Required)

| `` |

Image binary encoded in base64 without \.
- Supports: JPG, JPEG, PNG
- Max Size: 2MB
- Recommended size: 1024x768

| | cardDetect |

Boolean

(Default: true)

| Use card detection model | | passCardDetect |

Boolean

(Default: true)

| If `false`, when identity card is not detected on the image it will return an **error message** | | flipImage |

Boolean

(Default: false)

| If `true`, the system will flip your image | | checkFlipImage |

Boolean

(Default: false)

| If `true`, the system will check whether your image is flipped or not | | {% endtab %} | | | {% tab title="Example (Recommendation)" %} You just need to declare image field in order to use this service. ``` { "image": "/9j/..." } ``` {% endtab %} {% tab title="Example (Verbose)" %} ``` { "image": "string", "cardDetect": true, "passCardDetect": true, "flipImage": true, "checkFlipImage": true } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} `result` | Field | Type | Description | | --------------- | ---------------------------------------------------------------------------------- | ---------------- | | identityId | `String` | Identity id | | indicator | `String` | Indicator | | country | `String` | Country | | countryCode | `String` | Country code | | fullName | `String` | Full name | | nationality | `String` | Nationality | | nationalityCode | `String` | Nationality code | | birthDate | `String` | Date of birth | | sex |

String

\["male", "female"]

| Sex | | personalNumber | `String` | Personal number | | expirationDate |

Date

(dd-mm-yy)

| Expiration date | `information` | Field | Type | Description | | -------------- | --------- | ---------------------------------------------------------------------------------- | | tilt | `Float` | Tilt degree (0-360) on identity card. If it is upside-down, then the value is 180. | | `cardDetected` | `Boolean` | Return true if out system detected identity card on the image. | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "string", "data": { "id": "string", "result": { "identityId": "string", "indicator": "string", "country": "string", "countryCode": "string", "fullName": "string", "nationality": "string", "nationalityCode": "string", "birthDate": "string", "sex": "string", "personalNumber": "string", "expirationDate": "string" }, "information": { "tilt": float, "cardDetected": boolean } } } ``` {% endtab %} {% endtabs %} ### **Errors** {% hint style="info" %} Please read this [page \](/responses-and-errors) to know more about response. {% endhint %} **Error 4XX** {% tabs %} {% tab title="Error Type" %}
Error TypeDescriptionIs charged?
invalid_base64_encodingInvalid base64 encoding.false
card_not_foundThere is no identity card found in the image. This error only raised if you set passCardDetect = False.true
text_not_foundThere is no text found in the image.true
invalid_document_typeThe document sent does not appear to be the right identity type.true
parsing_failedSystem fail to parse identity card.true
{% endtab %} {% tab title="Structure" %} ``` { "errors":{ "errorId": , "errorType": }, "message": } ``` {% endtab %} {% endtabs %} **Error 5XX** **F**or every 5XX http code response, there will be no charge. # Face Recognition ## Introduction Face recognition help you to matching a human face from an image. ## Ability * Recognize face(s) in all orientations * Automatically detect and crop face(s) in the image ## Limitations The following is a list of conditions that can reduce performance of the model to recognize face. * Blurry image * Noisy image * Poorly lightning condition or light reflection (often flashlight) * Partially hidden or obstructed faces ## Under the Hood Kredibel is using **deep learning** to perform face recognition task. Our model achieve near **99.7%** accuracy in the labeled face in the wild (LFW) dataset. Below is an explanation of how our Face Detection system works. ### 1. Upload Image Users can upload a **handheld** or **non-handheld** identity card image. Our system can handle both. ### 2. Orientation estimation Our system will estimate image orientation and normalize it. That's why our system can recognize faces in all orientations. ### 3. Face Detection Our system will **detect** all face(s) in the image. ### 4. Cropping Our system will automatically **crop** the face area detected by face detection model. ### 5. Face Recognition Our system will **recognize** face(s) by extracting face unique features. ### 6. Face Comparison We **compare** face unique features of the given image. ## Endpoints | Method | URL | | ------ | ------------------------------ | | POST | `$vision/v1/face/verification` | # Face Comparison ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Model** Kredibel provide two different option of model for face recognition. Every model has its own advantages and disadvantages. We recommend you to try both of the model before deciding which model is the best fit for your case. | Version | Description | Threshold | | ------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | **1** | Model version 1 is the default model used for face recognition task. The model extract 512 facial features (landmarks). |

< 0.80: not match
>= 0.80: match

| | 2 | Model version 2 is the another model option for face recognition task. The model extract 128 facial features (landmarks). |

< 0.80: not match
>= 0.80: match

| ## **Non-Handheld** ### Endpoint | Method | URL | | ------ | ------------------------------------ | | POST | `$vision`**`/v1/face/verification`** | ### **Request** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ---------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | image1 | `` |

Image binary encoded in base64 without \.
- Supports: JPG, JPEG, PNG
- Max Size: 2MB

| | image2 | `` |

Image binary encoded in base64 without \.
- Supports: JPG, JPEG, PNG
- Max Size: 2MB

| | [modelVersion](#model) | `Integer` | Model version used to recognize the faces. Default version is 1. | | threshold | `Float (0-1)` | Threshold of the matched faces. | | {% endtab %} | | | {% tab title="Example" %} ``` { "image1": "", "image2": "" } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------------ | ------------- | --------------------------------------- | | similarity | `Float (0-1)` | Similarity value between the two images | | matched | `Boolean` | Matched | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "face verification succeded", "data": { "id": "8f9efedc-d5bf-11eb-9953-5517feb46cc4", "similarity": 0.7396538793680758, "matched": true } } ``` {% endtab %} {% endtabs %} ## Handheld ### Endpoint | | | | ------ | --------------------------------------------- | | Method | URL | | POST | `$vision`**`/v1/face/verification/handheld`** | ### **Request** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ---------------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | image | `` |

Image binary encoded in base64 without \.
- Supports: JPG, JPEG, PNG
- Max Size: 2MB

| | [modelVersion](#model) | `Integer` | Model version used to recognize the faces. Default version is 1. | | threshold | `Float (0-1)` | Threshold of the matched faces. | | {% endtab %} | | | {% tab title="Example" %} ``` { "image": "" } ``` {% endtab %} {% endtabs %} ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------------ | ------------- | --------------------------------------- | | similarity | `Float (0-1)` | Similarity value between the two images | | matched | `Boolean` | Matched | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "face verification succeded", "data": { "id": "8f9efedc-d5bf-11eb-9953-5517feb46cc4", "similarity": 0.7396538793680758, "matched": true } } ``` {% endtab %} {% endtabs %} ### **Errors** {% hint style="info" %} Please read this [page \](/responses-and-errors) to know more about response. {% endhint %} **Error 4XX** {% tabs %} {% tab title="Error Type" %}
Error TypeDescriptionIs charged?
invalid_base64_encodingInvalid base64 encoding.false
no_face_detectedNo face was detected from one of the images or both images.true
{% endtab %} {% tab title="Structure" %} ``` { "errors":{ "errorId": , "errorType": }, "message": } ``` {% endtab %} {% endtabs %} **Error 5XX** **F**or every 5XX http code response, there will be no charge. # Billing ## Endpoints * [Get credit amount](/api-references/billing/credit) # Credit Get total available billing credits. ## Endpoint | Method | URL | | ------ | ----------------------------------- | | GET | `$synapses`**`/v1/billing/credit`** | ### Headers | Header | Value | | --------------- | -------------------------------------------- | | `Authorization` | `Bearer` [`YOUR_API_KEY`](/authentication-1) | ### **Response** {% tabs %} {% tab title="Description" %} | Field | Type | Description | | ------------ | ----------- | ----------------------- | | amount | `Integer` | Total available credits | | updatedAt | `Timestamp` | Last update | | {% endtab %} | | | {% tab title="Example" %} ``` { "message": "Billing Status", "data": { "amount": 965526063, "updatedAt": 1627531044 } } ``` {% endtab %} {% endtabs %}