personal rich profile API

access profile information of an Orange France customer,
retrieve about thirty Orange France customers' profile information,
fill in automatically inscription forms with Orange profile

documentation

The Personal RichProfile API allows you - through your website - to access profile information of an Orange France customer. This API allows you to retrieve more customer profile information than the Personal Profile API, new attributes include customer’s photo, office information, interests, and many more. Altogether, about thirty attributes are available via the Personal RichProfile API.

Make sure you are familiar with the Personal APIs privacy management process.
This process protects Orange users by preventing third parties from accessing their personal data without their permission

1 . method

Replace PersonalRichProfileV1URL in the documentation by the following:

Environment	Endpoint
Production	https://alpha-api.orange.fr/PersonalRichProfile/V1
Integration	https://alpha-api.orange.fr/int/PersonalRichProfile/V1

a.getPersonalRichProfile

This method retrieves the profile information of an Orange user.

Request

[PersonalRichProfileV1URL]?action=getPersonalRichProfile&infos=[information]&token=[user token]

Parameters details available here >

Request parameter

Description

infos

type : string	mandatory
comma separated attribute list: Firstname,UserEMail,[...], UserType

token

type : string	mandatory
user token that is retrieved using the Authentication API

Response

Response 1: your service requested the firstname, lastname and usertype of an Orange user and the latter has granted access to all the attributes.

<?xml version="1.0" encoding="UTF-8" ?>
<getPersonalRichProfileReturn>
- <Data>
- - <UserAuthorizedData>
  - - <Firstnames>John</Firstname>
    - <Lastname><Doe></Lastname>
  - </UserAuthorizedData>
- </Data>
</getPersonalRichProfileReturn>

Response 2: your service requested the firstname, lastname and usertype of an Orange user but the latter has prevented you from accessing their usertype.

<?xml version="1.0" encoding="UTF-8" ?>
<getPersonalRichProfileReturn>
- <Data>
- - <UserAuthorizedData>
  - - <Firstnames>John</Firstname>
    - <Lastname>Doe</Lastname>
  - </UserAuthorizedData>
  - <UserProtectedData>
  - - <UserType/>
  - </UserProtectedData>
  - <PrivacyDashboardURL>[privacy interaction page]</PrivacyDashboardURL>
- </Data>
</getPersonalRichProfileReturn>

Parameters details available here >

Response parameter

Description

type : string

type : string

type : string

type : string

type : Integer
1: Ms 2: Mrs 3: Mr

type : string
YYYY-MM-DD (ISO 8601)

<NDP>

type : string
International format

type : string
International format

type : string
International format

type : string
International format

type : string
International format

type : string
International format

type : string

type : string

type : string

type : string
IETF RFC 3066

type : XML node
<HomeAddress> <Street1>2 rue Nunc</Street1> <Street2/> <ZipCode>75014</ZipCode> <City>Paris</City> <State/> <Country>FR</Country> </HomeAddress>

type : XML node
<HomeAddress> <Street1>2 rue Nunc</Street1> <Street2/> <ZipCode>75014</ZipCode> <City>Paris</City> <State/> <Country>FR</Country> </HomeAddress>

type : string
YYYY-MM-DDThh:mm (ISO 8601)

type : string
YYYY-MM-DDThh:mm (ISO 8601)

type : Integer
0: NSRU 1: I 2: M 3: I+M 4: NDRTC

type : string
URL

type : string
URL

type : string
URL

type : string
URL

type : string
1: Livres/ musiques/ vidéos 2: Voyages/ tourisme 3: Informatique 4: Automobile 5: Famille 6: Bricolage/ jardinage 7: Maison/ décoration 8: Gastronomie 9: Bourse/ finance 10: Sports 11: Beauté/ santé 12: Jeux/ jeux vidéos 13: Immobilier 14: Mode 15: Caritatif 16: Emploi 17: People 18: Cinema

2 . errors

When an error occurs, the response is in the following format:

<?xml version="1.0" encoding="UTF-8" ?>
<getPersonalRichProfileReturn>
- <error>
- - <code>[code value]</code>
  - <detail>[error detailed message]</detail>
- </error>
</getPersonalRichProfileReturn>

The table below describes the error codes that are specific to this API.
Please note that the descriptions given here are high level. If you want detailed error descriptions for certain codes, please contact us at developers@orange.com

Code	Description
102, 103	Error correlated to the user's account
203, 204, 205, 501, 503, 504, 505, 900	Internal error

3 . code examples

Before getting started, make sure you are familiar with the Personal APIs privacy management process.
The process protects Orange users by preventing third parties from accessing their personal data without their permission

retrieving profile information

Firstly, retrieve a user token using the Authentication API. This user token will be used as the "token" parameter in the Personal Rich Profile API call.

For more information, see how to authenticate user section.

You will then be able to call the following request:

[PersonalRichProfileV1URL]?action=getPersonalRichProfile&infos=Gender,Firstname,Lastname,DateOfBirth,HomeAddress,UserEMail,HomePhone&token=Hjlkzjlfkzef23423kjlkjr

Below is an example of response you could have if the user has already accepted the privacy:

<?xml version="1.0" encoding="UTF-8" ?>
<getPersonalRichProfileReturn>
- <Data>
- - <UserAuthorizedData>
  - - <Gender>1</Gender>
    - <Firstnames>John</Firstname>
    - <Lastname>Doe</Lastname>
    - <DateOfBirth>1970-03-22</DateOfBirth>
    - - <HomeAddress>
      - <Street1>2 rue Nunc</Street1>
        
        <Street2/>
        
        <ZipCode>75014</ZipCode>
        
        <City>Paris</City>
        
        <State/>
        
        <Country>FR</Country>
      - </HomeAddress>
    - <UserEMail>john.doe@orange.fr</UserEMail>
    - <HomePhone>+33123456789</HomePhone>
  - </UserAuthorizedData>
- </Data>
</getPersonalRichProfileReturn>

Orange API

connect to Orange API