Idenge

API Docs

Base URL

The base URL for Idenge endpoints is https://idenge.com/api

Authentication

Any API call needs to be Authenticated using APIKEY and APISECRET Headers. Both keys are available in the Profile section.

Error Handling

Error Code Description
401 Request is not authenticated. APIKEY or APISECRET are missing or incorrect
404 Resource does not exist
400 Error validating data. Check message in response for further information.

Users

Model to identify the Cardholders.

Schema:

Name Type Description
_id MongoDB ObjectID Identifies the User
name String User's name
email String User's email. doesn't allow duplicates.
phone String User's phone
status String One of [null, "installed", "uninstalled", "deleted"]
pass Object Identifies the User's Pass if any.
emailSent Boolean True if the "download pass" email has been sent
customImage String URL for a different user pass image. Used for promotions.
data Object 1 level Key-Value Object for custom data. Key corresponds with the field ID
externalId String Used for identify the user with a 3rd party platform
createdAt Date The date when the user was created
updatedAt Date The date when the user was last updated
passLastUpdated Date The date when the user's pass was last updated
customer MongoDB ObjectID Identifies the User's Customer (your Idenge account)
referal MongoDB ObjectID Identifies the User's Referal if any.

Example:


                        {
                            "_id": "5cd9561dab2156756bdcf709",
                            "email": "marcos.bermejo@idenge.com",
                            "name": "Marcos",
                            "phone": "665654",
                            "status": "installed",
                            "pass": {
                                platform: "ios",
                                urbanId: "12345"
                            },
                            "emailSent": true,
                            "data": {
                                "5d21b94aea405b2e01294df6": "150",
                                "5c8670c9ffcfc40681402664": "1985-12-24T23:00:00.000Z"
                            }
                            "externalId": "1234EE",
                            "createdAt": "2019-05-13T11:33:49.074Z",
                            "updatedAt": "2019-07-07T09:21:02.817Z",
                            "customer": "5c866f10ffcfc40681402660"
                        }                                       
                

List Users:


                        GET /users
                        APIKEY: myKey
                        APISECRET: mySecret
                

List Users filtered by attribute:

                         
                        GET /users?email=marcos.bermejo@idenge.com
                        APIKEY: myKey
                        APISECRET: mySecret                              
                

Create User


                        POST /users
                        APIKEY: myKey
                        APISECRET: mySecret                        
                        Content-Type: application/json

                        {
                            "email": "marcos.bermejo@idenge.com",
                            "name": "Marcos",
                            "phone": "665654",
                            "data": {
                                "5d21b94aea405b2e01294df6": "150",
                                "5c8670c9ffcfc40681402664": "1985-12-24T23:00:00.000Z"
                            }
                        }                           
                

Edit User


                        PATCH /users/5cd9561dab2156756bdcf709
                        APIKEY: myKey
                        APISECRET: mySecret                        
                        Content-Type: application/json                        

                        {
                            "name": "Marcos2",
                            "phone": null,
                            "data": {
                                "5d21b94aea405b2e01294df6": "150"
                            }
                        }
                

Data omitted in the Request, won't be edited. Nulls will be stored. Example above will edit name, store "null" in phone and leave the other fields unaltered